Infoproff API dokumentācija - v3


Darba sākšana


Web pakalpojuma wsdl un shēmas atrodas šeit.:

http://wsdfn.infoproff.com/v3/

Web service functions:

  • SimpleSearch - Meklēt informāciju par uzņēmumiem dažādās valstīs.
  • ChkFinance - Meklējiet pieejamos finanšu pārskatus.
  • Order - Izveido order_id un atgriež dublikātus. Dublikātus atlasa pēc nākamajiem parametriem: country, product, reg_code.
  • OrderCancellation - Ja nosūtījāt pasūtījuma pieprasījumu un saņēmāt order_id, jums ir iespēja atcelt pasūtījumu (ja tas nav nodots ražošanā).
  • OrderConfirmation - Pēc order_id saņemšanas jums būs jāapstiprina pasūtījums 1 stundas laikā. Ja 1 stundas laikā pasūtījumu neapstiprināsiet, pasūtījums tiks automātiski atcelts.
  • ChkStatus - Pārbaudiet pasūtījuma statusu.
  • GetReport - Saņemiet pabeigtus ziņojumus.

  • GetClassifiersFinancialStatements - Iegūst visus finanšu dokumentus ar visiem elementiem: rindu_numurs, rindas_formulēts_apraksts, rindas_valodas_atslēga un rindas_kārtība.
  • GetLegalForms - Iegūstiet visu pieejamo valstu juridiskās veidlapas.
  • GetActivityClassificators - Iegūstiet visus konkrētās darbības klasifikatora kodus un aprakstus.
  • GetDictionaryStandardPhrases - Iegūstiet visas standarta frāzes ar taustiņiem un valodu.
  • GetAvailableProducts - Saņemiet pieejamo produktu sarakstu.

  • CreditOpinionCalculator - Kredīta atzinuma kalkulators palīdz piešķirt kredītnovērtējumu uzņēmumam.

API nodrošina vairākus pakalpojumus:

  1. Tiešsaistes kredītziņojumi par šādām valstīm: Somijas Republika (FIN), Zviedrijas Karaliste (SWE), Beļģijas Karaliste (BEL), Nīderlandes Karaliste (NLD), Igaunijas Republika (EST)
  2. Bezsaistes ziņojumi par šādām valstīm: Visas valstis
  3. Kredīta viedokļa kalkulators

Kā meklēt uzņēmumu?


Uzņēmumu meklēšana sastāv no 2 iespējām:

  1. Meklēt pēc uzņēmuma nosaukuma,
  2. Search by company code.
Pieejamo valstu saraksts: Austrijas Republika (AUT), Azerbaidžānas Republika (AZE), Baltkrievijas Republika (BLR), Beļģijas Karaliste (BEL), Dānijas Karaliste (DNK), Francijas Republika (FRA), Grenlande (GRL), Gruzija (GEO), Igaunijas Republika (EST), Itālijas Republika (ITA), Kazahstānas Republika (KAZ), Kipras Republika (CYP), Kirgizstānas Republika (KGZ), Lielbritānijas un Ziemeļīrijas Apvienotā Karaliste (GBR), Moldovas Republika (MDA), Mongolija (MNG), Norvēģijas Karaliste (NOR), Nīderlandes Karaliste (NLD), Polijas Republika (POL), Portugāles Republika (PRT), Somijas Republika (FIN), Spānijas Karaliste (ESP), Uzbekistānas Republika (UZB), Vācijas Federatīvā Republika (DEU), Zviedrijas Karaliste (SWE), Īrija (IRL), Ķīnas Tautas Republika (CHN), Šveices Konfederācija (CHE)
Svarīga informācija:

search_result_id can be acquired here for orders with delivery_term = "o".

It may take up to 20 seconds to respond to a search request in the following countries: United Kingdom, Ireland, France, Spain, Portugal, Germany, Italy, Austria, Switzerland.

Norvēģijas reģistrs neļauj meklēt dzēstos uzņēmumus pēc nosaukumiem. Tāpēc mēs nevaram nodrošināt SimpleSearch pēc nosaukumiem Norvēģijā dzēstajos uzņēmumos.

Field's length:
company_name varchar(512)
company_code varchar(64)

Zemāk varat atrast piemēru:


Funkcija SimpleSearch

2. iespēja: meklēšana pēc reģistrācijas koda

Funkcija SimpleSearch

Kā pasūtīt kredītinformācijas ziņojumu?


List of available countries for online credit reports: Beļģijas Karaliste (BEL), Igaunijas Republika (EST), Kazahstānas Republika (KAZ), Kirgizstānas Republika (KGZ), Nīderlandes Karaliste (NLD), Polijas Republika (POL), Somijas Republika (FIN), Zviedrijas Karaliste (SWE)
Field's length:
business_name varchar(512)
reg_code varchar(64)
vat_code varchar(64)
address varchar(512)
phone varchar(256)
email varchar(256)
additional_info varchar(512)
ref_code varchar(64)

Below you can find the example of how to order and download reports:

STEP 1: Find a company (Online/Offline Order (with search_result_id))

Funkcija SimpleSearch

To order an Online/Offline with identification report you need to receive "<search_result_id>".
To do so, please follow the link: Kā meklēt uzņēmumu?

The search allows you to accurately identify the company you wish to place an order for. For example, in some countries, there may be several companies with one registration number, or the same official name may belong to several companies.

STEP 2: Order a report (Online/Offline Order (with search_result_id))

Funkcija Order
If you won't use the element confirm_order, then you will receive <last_duplicates> in the XML response, so that you can decide if you really need to place an order.

STEP 3: Order cancellation (Optional) (Online/Offline Order (with search_result_id))

Funkcija OrderCancellation
If you wish to cancel the order, you can use this OrderCancellation function. If the order is already in progress, then you won't be able to cancel it.

STEP 4: Order confirmation (Online/Offline Order (with search_result_id))

Funkcija OrderConfirmation
If you didn't use the element "confirm_order", then you need to confirm your order.

STEP 5: Check order status (Online/Offline Order (with search_result_id))

Funkcija ChkStatus
  • - For offline orders checking order status once every 30 minutes is acceptable frequency.
  • - For online orders checking order status once every 5 seconds is acceptable frequency.

Pārskatiem tiek izmantoti šādi statusi:

  • Izstrādes procesā - Ziņojums ražošanas posmā
  • Canceled - Atceltais pasūtījums
  • Finished - Ziņojums ir gatavs
  • Updated - Gatavajam ziņojumam tika pievienota informācija
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Mūsu sistēmā ir notikusi tehniska kļūda. Tas nozīmē, ka mēs esam informēti par šo kļūdu un pēc iespējas ātrāk to novērsīsim. Jūs tiksiet informēts, kad varēsiet saņemt pasūtījumu.

Ja izpildes statuss ir Finished vai Updated, tad varat saņemt rīkojumu.

STEP 6: Get report (Online/Offline Order (with search_result_id))

Funkcija GetReport
Pieejamo valodu saraksts: bg (Bulgāru), cs (Čehu), da (Dānijas), de (Vācu), el (Grieķu), en (Angļu valodā), es (Spāņu), et (Igauņu), fi (Somu), fr (Franču), hu (Ungāru), id (Indonēzijas), it (Itāļu), ja (Japāņu), ko (Korejas), lt (Lietuviešu), lv (Latviešu), nb (Norvēģu bokmål), nl (Holandiešu), pl (Polijas), pt (Portugāļu), ro (Rumāņu), ru (Krievu), sk (Slovākijas), sl (Slovēņu), sv (Zviedru), tr (Turcijas), uk (Ukraiņu), zh (Ķīniešu)

STEP 1: Order a report (Offline Order (without search_result_id))

Funkcija Order
If you won't use the element confirm_order, then you will receive <last_duplicates> in the XML response, so that you can decide if you really need to place an order.

STEP 2: Order cancellation (Optional) (Offline Order (without search_result_id))

Funkcija OrderCancellation
If you wish to cancel the order, you can use OrderCancellation function. If the order is already in progress, then you won't be able to cancel it.

STEP 3: Order confirmation (Offline Order (without search_result_id))

Funkcija OrderConfirmation
If you didn't use the element "confirm_order", then you need to confirm your order.

STEP 4: Status Checking (Offline Order (without search_result_id))

Funkcija ChkStatus
For offline orders checking order status once every 30 minutes is acceptable frequency.

Pārskatiem tiek izmantoti šādi statusi:

  • Izstrādes procesā - Ziņojums ražošanas posmā
  • Canceled - Atceltais pasūtījums
  • Finished - Ziņojums ir gatavs
  • Updated - Gatavajam ziņojumam tika pievienota informācija
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Mūsu sistēmā ir notikusi tehniska kļūda. Tas nozīmē, ka mēs esam informēti par šo kļūdu un pēc iespējas ātrāk to novērsīsim. Jūs tiksiet informēts, kad varēsiet saņemt pasūtījumu.

Ja izpildes statuss ir Finished vai Updated, tad varat saņemt rīkojumu.

STEP 5: Get report (Offline Order (without search_result_id))

Funkcija GetReport
Pieejamo valodu saraksts: bg (Bulgāru), cs (Čehu), da (Dānijas), de (Vācu), el (Grieķu), en (Angļu valodā), es (Spāņu), et (Igauņu), fi (Somu), fr (Franču), hu (Ungāru), id (Indonēzijas), it (Itāļu), ja (Japāņu), ko (Korejas), lt (Lietuviešu), lv (Latviešu), nb (Norvēģu bokmål), nl (Holandiešu), pl (Polijas), pt (Portugāļu), ro (Rumāņu), ru (Krievu), sk (Slovākijas), sl (Slovēņu), sv (Zviedru), tr (Turcijas), uk (Ukraiņu), zh (Ķīniešu)

Kā pasūtīt finanšu pārskatus tiešsaistē?


STEP 1: Find a company

Funkcija SimpleSearch

To order an online financial statements, you need to receive "<search_result_id>".
To do so, please follow the link: Kā meklēt uzņēmumu?

The search allows you to accurately identify the company you wish to place an order for. For example, in some countries, there may be several companies with one registration number, or the same official name may belong to several companies.

STEP 2: Pieejamo finanšu pārskatu meklēšana

Funkcija ChkFinance

Šī funkcija ir nepieciešama tikai tad, ja tiek pasūtīts produkts: finances (Financial statements) ar delivery_term = 'o'.

Pieejamo valstu saraksts: Igaunijas Republika (EST), Zviedrijas Karaliste (SWE)

STEP 3: Finanšu pārskatu pasūtīšana

Funkcija Order
If you won't use the element confirm_order, then you will receive <last_duplicates> in the XML response, so that you can decide if you really need to place an order.

STEP 4: Order cancellation (Optional)

Funkcija OrderCancellation
If you wish to cancel the order, you can use this OrderCancellation function. If the order is already in progress, then you won't be able to cancel it.
To see the examples of xml request/response, please follow the link: How to cancel the order?

STEP 5: Order confirmation

Funkcija OrderConfirmation
If you didn't use the element "confirm_order", then you need to confirm your order.
To see the examples of xml request/response, please follow the link: How to confirm the order?

STEP 6: Check order status

Funkcija ChkStatus
  • - For online orders checking order status once every 5 seconds is acceptable frequency.

Pārskatiem tiek izmantoti šādi statusi:

  • Izstrādes procesā - Ziņojums ražošanas posmā
  • Canceled - Atceltais pasūtījums
  • Finished - Ziņojums ir gatavs
  • Updated - Gatavajam ziņojumam tika pievienota informācija
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Mūsu sistēmā ir notikusi tehniska kļūda. Tas nozīmē, ka mēs esam informēti par šo kļūdu un pēc iespējas ātrāk to novērsīsim. Jūs tiksiet informēts, kad varēsiet saņemt pasūtījumu.

If the execution status is Finished or Updated, then you can get an order.

To see the examples of xml request/response, please follow the link: How to check order status?

STEP 7: Get report

Funkcija GetReport
Pieejamo valodu saraksts: bg (Bulgāru), cs (Čehu), da (Dānijas), de (Vācu), el (Grieķu), en (Angļu valodā), es (Spāņu), et (Igauņu), fi (Somu), fr (Franču), hu (Ungāru), id (Indonēzijas), it (Itāļu), ja (Japāņu), ko (Korejas), lt (Lietuviešu), lv (Latviešu), nb (Norvēģu bokmål), nl (Holandiešu), pl (Polijas), pt (Portugāļu), ro (Rumāņu), ru (Krievu), sk (Slovākijas), sl (Slovēņu), sv (Zviedru), tr (Turcijas), uk (Ukraiņu), zh (Ķīniešu)
To see the examples of xml request/response, please follow the link: How to get finished order?

Kā lejupielādēt standarta pārskatus (citos formātos, kas nav XML)?


Types of standard product: Basic Report, Mini Report, Linkages, Registration Data Report, Full report (private person), Short report (private person), Full report (with research), Financials (bank), Short Report, Real estate ownership search, Extended report, Full Report, KYC Report, Linked persons, Credit Opinion, Financial statements.

Pieprasījums sastāv no 3 daļām:

  1. Fiksētā daļa https://www.infoproff.com/en/orders/files/
  2. Jūsu unikālais hash, ko mēs sniedzam kā atbildi.
  3. And fixed part at the end /report?&lang=en&doc_type=pdf&currency_position=left&preferred_currency=EUR
https://www.infoproff.com/en/orders/files/<order_hash>/report?&lang=en&doc_type=pdf&currency_position=left&preferred_currency=EUR
lang: en, et, ru, lv, bg, cs, da, de, el, fi, fr, hu, id, it, ja, ko, lt, nl, nb, pl, pt, ro, sk, sl, es, sv, tr, uk, zh
doc_type: pdf, html, docx, xlsx
currency_position: left, right
preferred_currency: XXX - Oriģināls (bez apmaiņas), EUR, USD, AUD, BGN, BRL, CAD, CHF, CNY, CZK, DKK, GBP, HKD, HRK, HUF, IDR, ILS, INR, ISK, JPY, KRW, MXN, MYR, NOK, NZD, PHP, PLN, RON, RUB, SEK, SGD, THB, TRY, ZAR

Kā lejupielādēt nestandarta produktus?


Types of non-standard product: Marketing database (special offer), Site visit - non-capital city, Extract from registry, Site visit - capital city, Due Diligence, non-standard, Shareholder document, Memorandum of Association, Certificate of incorporation.

Pieprasījums sastāv no 3 daļām:

  1. Fixed part https://www.infoproff.com/en/orders/files/
  2. Jūsu unikālais hash, ko mēs sniedzam kā atbildi.
  3. Un fiksēto daļu beigās /download

Kā saņemt kredīta atzinumu?


Funkcija CreditOpinionCalculator

Kā iegūt papildu informāciju?


Funkcija GetClassifiersFinancialStatements
Funkcija GetActivityClassificators
Funkcija GetDictionaryStandardPhrases
Funkcija GetAvailableProducts

delivery_term:

  1. "o" = "Online"
  2. "n" = "Normal"
  3. "f" = "Flash"
  4. "s" = "SuperFlash"

Iespējamās kļūdas


Veicot pieprasījumu mūsu tīmekļa pakalpojumam, var rasties šādas kļūdas..


Visas funkcijas
  • Incorrect username/password or you have no permissions.
    Jūs ievadāt nepareizus akreditācijas datus vai jūsu API piekļuve ir bloķēta.

Funkcija SimpleSearch
  1. You don't have permissions to search in this country.
    Pieejamo valstu saraksts: Austrijas Republika (AUT), Azerbaidžānas Republika (AZE), Baltkrievijas Republika (BLR), Beļģijas Karaliste (BEL), Dānijas Karaliste (DNK), Francijas Republika (FRA), Grenlande (GRL), Gruzija (GEO), Igaunijas Republika (EST), Itālijas Republika (ITA), Kazahstānas Republika (KAZ), Kipras Republika (CYP), Kirgizstānas Republika (KGZ), Lielbritānijas un Ziemeļīrijas Apvienotā Karaliste (GBR), Moldovas Republika (MDA), Mongolija (MNG), Norvēģijas Karaliste (NOR), Nīderlandes Karaliste (NLD), Polijas Republika (POL), Portugāles Republika (PRT), Somijas Republika (FIN), Spānijas Karaliste (ESP), Uzbekistānas Republika (UZB), Vācijas Federatīvā Republika (DEU), Zviedrijas Karaliste (SWE), Īrija (IRL), Ķīnas Tautas Republika (CHN), Šveices Konfederācija (CHE)
Funkcija Order
  1. This product is not available.
    Šādu produktu nevar atrast un nav iespējams pasūtīt.
  2. You can't order report on company with legal form: "legal_form"
    Šī kļūda attiecas tikai uz: Zviedrijas Karaliste (SWE)
    Zviedrijā nav iespējams pasūtīt tiešsaistes ziņojumu (delivery_term = "o") ar nākamajām juridiskajām veidlapām:
    • enskild näringsidkare
    • kommanditbolag
    • handelsbolag
  3. When delivery term is Online, please use order_details_by_id with search_result_id.
    This error only appears if you are trying to order online report without search_result_id.
    It is important yo use order_details_by_id in OrderReportRequest
  4. Business Name or Reg Code is required
    Pasūtot bezsaistes pārskatu (delivery_term = "n", "f" vai "s"), ir jānorāda "Uzņēmuma nosaukums" vai "Reģistrācijas kods".
  5. Reg Code is required when delivery term is Online
    Pasūtot tiešsaistes pārskatu (delivery_term = "o"), ir jānorāda "Reģistrācijas kods".

Funkcija GetReport
  1. This language is not supported.
    Tiešsaistes pārskatu pieejamo valodu saraksts: bg (Bulgāru), cs (Čehu), da (Dānijas), de (Vācu), el (Grieķu), en (Angļu valodā), es (Spāņu), et (Igauņu), fi (Somu), fr (Franču), hu (Ungāru), id (Indonēzijas), it (Itāļu), ja (Japāņu), ko (Korejas), lt (Lietuviešu), lv (Latviešu), nb (Norvēģu bokmål), nl (Holandiešu), pl (Polijas), pt (Portugāļu), ro (Rumāņu), ru (Krievu), sk (Slovākijas), sl (Slovēņu), sv (Zviedru), tr (Turcijas), uk (Ukraiņu), zh (Ķīniešu)

Funkcijas GetReport ChkStatus
  1. Incorrect order_id.
    Pasūtījuma ID nav atrodams. Pasūtījuma ID iegūsiet, kad izmantosiet Order funkciju.

Funkcija OrderCancellation
  1. Your order is already canceled.
    Jums vairs nav atļaujas atcelt pasūtījumu.

Funkcija OrderConfirmation
  1. You don't have permission to confirm the order anymore. Confirmation can be done within one hour after you recieved 'order_id'.

SOAP (3. versija) izmaiņas salīdzinājumā ar SOAP (2. versija)


SOAP (3. versija) izmaiņas salīdzinājumā ar SOAP (2. versija) [Overview]

1) New function: ChkFinance

Allows you to search for available financial statements.
Currently available only in EST (Estonia), SWE (Sweden)

2) Function: SimpleSearch

- Changes in list of available countries: Austrijas Republika (AUT), Azerbaidžānas Republika (AZE), Baltkrievijas Republika (BLR), Beļģijas Karaliste (BEL), Dānijas Karaliste (DNK), Francijas Republika (FRA), Grenlande (GRL), Gruzija (GEO), Igaunijas Republika (EST), Itālijas Republika (ITA), Kazahstānas Republika (KAZ), Kipras Republika (CYP), Kirgizstānas Republika (KGZ), Lielbritānijas un Ziemeļīrijas Apvienotā Karaliste (GBR), Moldovas Republika (MDA), Mongolija (MNG), Norvēģijas Karaliste (NOR), Nīderlandes Karaliste (NLD), Polijas Republika (POL), Portugāles Republika (PRT), Somijas Republika (FIN), Spānijas Karaliste (ESP), Uzbekistānas Republika (UZB), Vācijas Federatīvā Republika (DEU), Zviedrijas Karaliste (SWE), Īrija (IRL), Ķīnas Tautas Republika (CHN), Šveices Konfederācija (CHE)

- Each time you place an request we asaign a new 'search_result_id' for each company. You need to use this 'search_result_id' to place online orders.

Also you can place offline (delivery_term = 'n', 'f' or 's') orders with 'search_result_id', if you desire.

3) Function: Order
Identification is required!

To place an online order, you need to recieve 'search_result_id' from function 'SimpleSearch', and only after that you can place an online (delivery_term = 'o') order.

- Changes in list of available countries for online credit reports: Beļģijas Karaliste (BEL), Igaunijas Republika (EST), Kazahstānas Republika (KAZ), Kirgizstānas Republika (KGZ), Nīderlandes Karaliste (NLD), Polijas Republika (POL), Somijas Republika (FIN), Zviedrijas Karaliste (SWE)

- Available to download financial statements (using product: finances) in online mode: Estonia (EST), Sweden (SWE)

3) Function: GetReport

- Changes in of available languages: bg (Bulgāru), cs (Čehu), da (Dānijas), de (Vācu), el (Grieķu), en (Angļu valodā), es (Spāņu), et (Igauņu), fi (Somu), fr (Franču), hu (Ungāru), id (Indonēzijas), it (Itāļu), ja (Japāņu), ko (Korejas), lt (Lietuviešu), lv (Latviešu), nb (Norvēģu bokmål), nl (Holandiešu), pl (Polijas), pt (Portugāļu), ro (Rumāņu), ru (Krievu), sk (Slovākijas), sl (Slovēņu), sv (Zviedru), tr (Turcijas), uk (Ukraiņu), zh (Ķīniešu)


SOAP (3. versija) izmaiņas salīdzinājumā ar SOAP (2. versija) [WSDL and XSD]

File: report.xsd

New elements:

- report/negative_information/debts/item/remainder_range

- report/negative_information/debts/item/remainder_non_standard_range

File: report.wsdl

New function:

- ChkFinance

Function that allows you to search for available financial statements.

NB: This function is only needed when ordering a product: finances (Financial statements) with delivery_term = 'o'.
File: order.xsd

1) OrderReportRequest has a choice:

- order_details:

Using general information: business_name, reg_code, vat_code, address, phone, email, additional_info

NB:
* Business Name or Registration Code is required
* Only for orders with delivery_term: 'n', 'f' and 's' (credit reports in offline mode)

- order_details_by_id:

Using 'search_result_id'

NB:
* 'search_result_id' can be obtained with function: 'SimpleSearch'
* each new search generates new 'search_result_id'

2) order_details

New element:

- preferable_finances

NB: This element is required only ordering a product: finances (Financial statements) with delivery_term = 'o'.

3) SimpleSearchRequest

Removed element:

search_block.reg_code

New element:

search_block->company_code

NB: in some countries we allow to search companies by vat_code.

4) SimpleSearchResponse

Removed elements

- code

Jauni elementi:

  • - search_result_id (is required for order with delivery_term = 'o')
  • - name_transliteration
  • - reg_code
  • - vat_code
  • - unified_legal_form

Webhooks Settings


Pārskats

Tīmekļa āķis ir veids, kā lietojumprogramma var sniegt citām lietojumprogrammām reāllaika informāciju. Mūsu webhook funkcija īsteno HTTP izsaukumus, kas konfigurēti ar URL. Uz šo URL tiek nosūtīta HTTP POST slodze JSON formātā, kad vien notiek kāds noteikts notikums. Mūsu projekta kontekstā mēs esam izstrādājuši webhook funkciju, lai izraisītu konkrētus notikumus.

Webhook iestatīšana

Lai iestatītu tīmekļa āķi savai lietojumprogrammai, dodieties uz lietojumprogrammas iestatījumu lapu un meklējiet sadaļu "Webhooks iestatījumi". Un norādiet šādu informāciju:

  1. "Webhook URL " ir URL, kurā serveris saņems webhook POST pieprasījumus.
  2. "Delivery max attempts" ir iestatījums, kas nosaka maksimālo atkārtoto mēģinājumu skaitu, kas jāveic, lai piegādātu tīmekļa piesaistes notikumu, ja sākotnējais piegādes mēģinājums ir neveiksmīgs.
  3. "Piegādes atkārtošanas laiks " ir iestatījums, kas ļauj norādīt laika intervālu starp atkārtotiem mēģinājumiem, ja tīmekļa piesaistes piegādes mēģinājums neizdodas.

Pēc šīs informācijas norādīšanas noklikšķiniet uz "Saglabāt".

Webhook notikumu tipi

  1. Jauns pasūtījuma statuss

Webhook lietderīgā slodze

Kad notikums ir noticis, mēs nosūtīsim HTTP POST pieprasījumu uz lietderīgās slodzes URL ar JSON ķermeni, kurā būs informācija par notikumu.

Lūk, derīgās slodzes piemērs:
Pasūtījuma jaunā statusa maksājuma piemērs
Iespējamās lauka "new_status" vērtības:
  • "Finished" - pasūtījums ir pabeigts. Pasūtījumu var saņemt;
  • "Updated" - atjaunināts pasūtījums, pabeigtam pasūtījumam pievienoti dati.;
  • "Canceled" - pasūtījums tiek atcelts pēc klienta pieprasījuma (vai piekrišanas).;
  • "Rejected" - pasūtījums tiek noraidīts. Parasti tāpēc, ka uzņēmumu nav iespējams identificēt..

Tīmekļa āķu nodrošināšana

Ir svarīgi pārbaudīt, vai POST pieprasījumi, kas nosūtīti uz lietojumprogrammas lietojumprogrammas ielādes URL, ir nosūtīti no mūsu lietojumprogrammas. Lai to palīdzētu izdarīt, katrā webhook pieprasījumā ir iekļauta X-Signature galvene.

Paraksts Apraksts

Parakstīšanai mēs izmantojam HMAC ar SHA512 algoritmu.

Slepenais ir lietojumprogrammas ID un slepenās atslēgas konkatenācija no tīmekļa āķa iestatījumiem.

Nepieciešamības gadījumā ir iespējams pievienot beigu punktam savus get params, lai identificētu sūtītāju.

Problēmu novēršana

Serverim jāatbild 10 sekunžu laikā un jāatgriež HTTP kods 2XX; pretējā gadījumā tīmekļa piesaistes piegāde tiek uzskatīta par neveiksmīgu. Neveiksmes gadījumā funkcija mēģinās atkārtoti nosūtīt pieprasījumu atbilstoši piegādes politikai.