Infoproff API dokumentáció - v3

Switch verzió V3

Kezdő lépések

A webszolgáltatás wsdl és sémák itt találhatók:

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

Web service functions:

  • SimpleSearch - Céginformációk keresése különböző országokban.
  • ChkFinance - Keresés a rendelkezésre álló pénzügyi kimutatások után.
  • Order - Létrehoz egy order_id címet és visszaadja a duplikátumokat. A duplikátumokat a következő paraméterek alapján választja ki: country, product, reg_code.
  • OrderCancellation - Ha elküldött egy megrendelési kérelmet, és megkapta a order_id, akkor lehetősége van arra, hogy törölje ezt a megrendelést (ha nem ment a termelésbe).
  • OrderConfirmation - Miután megkapta a order_id címet, 1 órán belül meg kell erősítenie a megrendelését. Ha nem erősíti meg a megrendelést 1 órán belül, a megrendelés automatikusan törlésre kerül.
  • ChkStatus - Ellenőrizze a rendelés státuszát.
  • GetReport - Szerezze be a kész jelentéseket.
  • GetClassifiersFinancialStatements - Az összes pénzügyi dokumentum lekérdezése az összes elemmel: row_number, row_formated_description, row_lang_key és row_order.
  • GetLegalForms - Szerezze be az összes jogi formanyomtatványt az összes rendelkezésre álló országhoz.
  • GetActivityClassificators - Az összes kód és leírás lekérdezése az adott tevékenységosztályozóhoz.
  • GetDictionaryStandardPhrases - Kapja meg az összes szabványos kifejezést kulcsokkal és nyelvvel.
  • GetAvailableProducts - A rendelkezésre álló termékek listája.
  • CreditOpinionCalculator - A Credit Opinion Calculator segít a vállalatra vonatkozó hitelminősítéshez hozzárendelni a hitelminősítést.

Az API számos szolgáltatást nyújt:

  1. Online hiteljelentések a következő országok számára: Finn Köztársaság (FIN), Svéd Királyság (SWE), Belga Királyság (BEL), Holland Királyság (NLD), Észt Köztársaság (EST)
  2. Offline jelentések a következő országok számára: Minden ország
  3. Hitel vélemény kalkulátor

Hogyan keressünk céget?

A cégkeresés 2 lehetőségből áll:

  1. Keresés cégnév alapján,
  2. Search by company code.
Az elérhető országok listája: Ausztrál Államszövetség (AUS), Azerbajdzsáni Köztársaság (AZE), Belga Királyság (BEL), Ciprusi Köztársaság (CYP), Dán Királyság (DNK), Egyesült Arab Emírségek (ARE), Fehérorosz Köztársaság (BLR), Finn Köztársaság (FIN), Francia Köztársaság (FRA), Georgia (GEO), Grönland (GRL), Holland Királyság (NLD), Hong Kong (HKG), Izrael Állam (ISR), Japán (JPN), Kazah Köztársaság (KAZ), Kirgiz Köztársaság (KGZ), Koszovó (XXK), Kínai Köztársaság (TWN), Kínai Népköztársaság (CHN), Lengyel Köztársaság (POL), Lett Köztársaság (LVA), Moldovai Köztársaság (MDA), Mongólia (MNG), Nagy-Britannia és Észak-Írország Egyesült Királysága (GBR), Norvég Királyság (NOR), Németországi Szövetségi Köztársaság (DEU), Olasz Köztársaság (ITA), Osztrák Köztársaság (AUT), Portugál Köztársaság (PRT), Seychelle Köztársaság (SYC), Spanyol Királyság (ESP), Svájci Államszövetség (CHE), Svéd Királyság (SWE), Szamoa Független Állam (WSM), Szingapúri Köztársaság (SGP), Tádzsik Köztársaság (TJK), Észt Köztársaság (EST), Írország (IRL), Üzbég Köztársaság (UZB)
Fontos információk:

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.

A norvég nyilvántartás nem teszi lehetővé a törölt vállalatok név szerinti keresését. Ezért nem tudunk a norvégiai törölt vállalatokon belül a SimpleSearch oldalon név szerint keresni.

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

Az alábbiakban a példát találja:

Funkció SimpleSearch

2. lehetőség: Keresés regisztrációs kód alapján

Funkció SimpleSearch

Option 3: Search by query (by name or code)

Funkció UnifiedSearch

Hogyan rendelhetek hiteljelentést?

List of available countries for online credit reports: Belga Királyság (BEL), Finn Köztársaság (FIN), Holland Királyság (NLD), Kazah Köztársaság (KAZ), Kirgiz Köztársaság (KGZ), Kínai Népköztársaság (CHN), Lengyel Köztársaság (POL), Mongólia (MNG), Svéd Királyság (SWE), Észt Köztársaság (EST)
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))

Funkció SimpleSearch

To order an Online/Offline with identification report you need to receive "<search_result_id>".
To do so, please follow the link: Hogyan keressünk céget?

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))

Funkció 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))

Funkció 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))

Funkció 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))

Funkció 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.

A következő státuszokat használják a jelentésekhez:

  • Folyamatban - Jelentés a gyártási szakaszban
  • Canceled - Törölt megrendelés
  • Finished - A jelentés elkészült
  • Updated - A kész jelentés kiegészült információkkal
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Technikai hiba történt a rendszerünkben. Ez azt jelenti, hogy értesültünk a hibáról, és a lehető leghamarabb kijavítjuk. Értesítjük Önt, ha a megrendelést át tudja venni.

Ha a végrehajtási státusz Finished vagy Updated, akkor kaphat megbízást.

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

Funkció GetReport
Az elérhető nyelvek listája: bg (Bolgár), cs (Cseh), da (Dán), de (Német), el (Görög), en (Angol), es (Spanyol), et (Észt), fi (Finn), fr (Francia), hu (Magyar), id (Indonéz), it (Olasz), ja (Japán), ko (Koreai), lt (Litvánia), lv (Lett), nb (Norvég Bokmål), nl (Holland), pl (Lengyel), pt (Portugál), ro (Román), ru (Orosz), sk (Szlovák), sl (Szlovén), sr (Српски), sv (Svéd), tr (Török), uk (Ukrán), zh (Kínai)

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

Funkció 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))

Funkció 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))

Funkció 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))

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

A következő státuszokat használják a jelentésekhez:

  • Folyamatban - Jelentés a gyártási szakaszban
  • Canceled - Törölt megrendelés
  • Finished - A jelentés elkészült
  • Updated - A kész jelentés kiegészült információkkal
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Technikai hiba történt a rendszerünkben. Ez azt jelenti, hogy értesültünk a hibáról, és a lehető leghamarabb kijavítjuk. Értesítjük Önt, ha a megrendelést át tudja venni.

Ha a végrehajtási státusz Finished vagy Updated, akkor kaphat megbízást.

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

Funkció GetReport
Az elérhető nyelvek listája: bg (Bolgár), cs (Cseh), da (Dán), de (Német), el (Görög), en (Angol), es (Spanyol), et (Észt), fi (Finn), fr (Francia), hu (Magyar), id (Indonéz), it (Olasz), ja (Japán), ko (Koreai), lt (Litvánia), lv (Lett), nb (Norvég Bokmål), nl (Holland), pl (Lengyel), pt (Portugál), ro (Román), ru (Orosz), sk (Szlovák), sl (Szlovén), sr (Српски), sv (Svéd), tr (Török), uk (Ukrán), zh (Kínai)

Hogyan rendelhetek online pénzügyi kimutatásokat?

STEP 1: Find a company

Funkció SimpleSearch

To order an online financial statements, you need to receive "<search_result_id>".
To do so, please follow the link: Hogyan keressünk céget?

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: Elérhető pénzügyi kimutatások keresése

Funkció ChkFinance

Erre a funkcióra csak termékrendelés esetén van szükség: finances (Financial statements) a delivery_term = 'o' címmel.

Az elérhető országok listája: Észt Köztársaság (EST), Svéd Királyság (SWE)

STEP 3: Pénzügyi kimutatások megrendelése

Funkció 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)

Funkció 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

Funkció 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

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

A következő státuszokat használják a jelentésekhez:

  • Folyamatban - Jelentés a gyártási szakaszban
  • Canceled - Törölt megrendelés
  • Finished - A jelentés elkészült
  • Updated - A kész jelentés kiegészült információkkal
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Technikai hiba történt a rendszerünkben. Ez azt jelenti, hogy értesültünk a hibáról, és a lehető leghamarabb kijavítjuk. Értesítjük Önt, ha a megrendelést át tudja venni.

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

Funkció GetReport
Az elérhető nyelvek listája: bg (Bolgár), cs (Cseh), da (Dán), de (Német), el (Görög), en (Angol), es (Spanyol), et (Észt), fi (Finn), fr (Francia), hu (Magyar), id (Indonéz), it (Olasz), ja (Japán), ko (Koreai), lt (Litvánia), lv (Lett), nb (Norvég Bokmål), nl (Holland), pl (Lengyel), pt (Portugál), ro (Román), ru (Orosz), sk (Szlovák), sl (Szlovén), sr (Српски), sv (Svéd), tr (Török), uk (Ukrán), zh (Kínai)
To see the examples of xml request/response, please follow the link: How to get finished order?

Hogyan tölthetem le a szabványos jelentéseket (az XML-től eltérő formátumban)?

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.

A kérelem 3 részből áll:

  1. Rögzített rész https://www.infoproff.com/en/orders/files/
  2. Az Ön egyedi azonosítószámát, amelyet válaszul adunk meg.
  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, sr, sv, tr, uk, zh
doc_type: pdf, html, docx, xlsx
currency_position: left, right
preferred_currency: XXX - Eredeti (nincs csere), 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

Hogyan tölthetünk le nem szabványos termékeket?

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.

A kérelem 3 részből áll:

  1. Fixed part https://www.infoproff.com/en/orders/files/
  2. Az Ön egyedi azonosítószámát, amelyet válaszul adunk meg.
  3. És a végén rögzített rész /download

Hogyan lehet hitelvéleményt szerezni?

Funkció CreditOpinionCalculator

Hogyan juthatok további információkhoz?

Funkció GetClassifiersFinancialStatements
Funkció GetActivityClassificators
Funkció GetDictionaryStandardPhrases
Funkció GetAvailableProducts

delivery_term:

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

Lehetséges hibák

Ezek a hibák előfordulhatnak a webes szolgáltatásunkhoz intézett kérés során.

Minden funkció
  • Incorrect username/password or you have no permissions.
    Rossz hitelesítő adatokat adtál meg, vagy az API-hozzáférésed blokkolva van.
Funkció SimpleSearch
  1. You don't have permissions to search in this country.
    Az elérhető országok listája: Ausztrál Államszövetség (AUS), Azerbajdzsáni Köztársaság (AZE), Belga Királyság (BEL), Ciprusi Köztársaság (CYP), Dán Királyság (DNK), Egyesült Arab Emírségek (ARE), Fehérorosz Köztársaság (BLR), Finn Köztársaság (FIN), Francia Köztársaság (FRA), Georgia (GEO), Grönland (GRL), Holland Királyság (NLD), Hong Kong (HKG), Izrael Állam (ISR), Japán (JPN), Kazah Köztársaság (KAZ), Kirgiz Köztársaság (KGZ), Koszovó (XXK), Kínai Köztársaság (TWN), Kínai Népköztársaság (CHN), Lengyel Köztársaság (POL), Lett Köztársaság (LVA), Moldovai Köztársaság (MDA), Mongólia (MNG), Nagy-Britannia és Észak-Írország Egyesült Királysága (GBR), Norvég Királyság (NOR), Németországi Szövetségi Köztársaság (DEU), Olasz Köztársaság (ITA), Osztrák Köztársaság (AUT), Portugál Köztársaság (PRT), Seychelle Köztársaság (SYC), Spanyol Királyság (ESP), Svájci Államszövetség (CHE), Svéd Királyság (SWE), Szamoa Független Állam (WSM), Szingapúri Köztársaság (SGP), Tádzsik Köztársaság (TJK), Észt Köztársaság (EST), Írország (IRL), Üzbég Köztársaság (UZB)
Funkció Order
  1. This product is not available.
    Ilyen termék nem található, és nem lehet megrendelni.
  2. You can't order report on company with legal form: "legal_form"
    Ez a hiba csak a következőkre vonatkozik: Svéd Királyság (SWE)
    Svédországban nem lehet online jelentést (delivery_term = "o") rendelni a következő jogi formanyomtatványokkal:
    • 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
    Offline jelentés megrendelésekor (delivery_term = "n", "f" vagy "s") a "Business Name" vagy "Reg Code" megadása kötelező.
  5. Reg Code is required when delivery term is Online
    Online jelentés megrendelésekor (delivery_term = "o") a "Reg Code" megadása kötelező.
Funkció GetReport
  1. This language is not supported.
    Az online jelentésekhez rendelkezésre álló nyelvek listája: bg (Bolgár), cs (Cseh), da (Dán), de (Német), el (Görög), en (Angol), es (Spanyol), et (Észt), fi (Finn), fr (Francia), hu (Magyar), id (Indonéz), it (Olasz), ja (Japán), ko (Koreai), lt (Litvánia), lv (Lett), nb (Norvég Bokmål), nl (Holland), pl (Lengyel), pt (Portugál), ro (Román), ru (Orosz), sk (Szlovák), sl (Szlovén), sr (Српски), sv (Svéd), tr (Török), uk (Ukrán), zh (Kínai)
Funkciók GetReport ChkStatus
  1. Incorrect order_id.
    A rendelés azonosítója nem található. A rendelés azonosítóját a Order funkció használatával kapja meg.
Funkció OrderCancellation
  1. Your order is already canceled.
    Már nincs engedélye a megrendelés törlésére.
Funkció OrderConfirmation
  1. You don't have permission to confirm the order anymore. Confirmation can be done within one hour after you recieved 'order_id'.

A SOAP (3. verzió) változásai a SOAP (2. verzióhoz képest)

A SOAP (3. verzió) változásai a SOAP (2. verzióhoz képest) [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: Ausztrál Államszövetség (AUS), Azerbajdzsáni Köztársaság (AZE), Belga Királyság (BEL), Ciprusi Köztársaság (CYP), Dán Királyság (DNK), Egyesült Arab Emírségek (ARE), Fehérorosz Köztársaság (BLR), Finn Köztársaság (FIN), Francia Köztársaság (FRA), Georgia (GEO), Grönland (GRL), Holland Királyság (NLD), Hong Kong (HKG), Izrael Állam (ISR), Japán (JPN), Kazah Köztársaság (KAZ), Kirgiz Köztársaság (KGZ), Koszovó (XXK), Kínai Köztársaság (TWN), Kínai Népköztársaság (CHN), Lengyel Köztársaság (POL), Lett Köztársaság (LVA), Moldovai Köztársaság (MDA), Mongólia (MNG), Nagy-Britannia és Észak-Írország Egyesült Királysága (GBR), Norvég Királyság (NOR), Németországi Szövetségi Köztársaság (DEU), Olasz Köztársaság (ITA), Osztrák Köztársaság (AUT), Portugál Köztársaság (PRT), Seychelle Köztársaság (SYC), Spanyol Királyság (ESP), Svájci Államszövetség (CHE), Svéd Királyság (SWE), Szamoa Független Állam (WSM), Szingapúri Köztársaság (SGP), Tádzsik Köztársaság (TJK), Észt Köztársaság (EST), Írország (IRL), Üzbég Köztársaság (UZB)

- 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: Belga Királyság (BEL), Finn Köztársaság (FIN), Holland Királyság (NLD), Kazah Köztársaság (KAZ), Kirgiz Köztársaság (KGZ), Kínai Népköztársaság (CHN), Lengyel Köztársaság (POL), Mongólia (MNG), Svéd Királyság (SWE), Észt Köztársaság (EST)

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

3) Function: GetReport

- Changes in of available languages: bg (Bolgár), cs (Cseh), da (Dán), de (Német), el (Görög), en (Angol), es (Spanyol), et (Észt), fi (Finn), fr (Francia), hu (Magyar), id (Indonéz), it (Olasz), ja (Japán), ko (Koreai), lt (Litvánia), lv (Lett), nb (Norvég Bokmål), nl (Holland), pl (Lengyel), pt (Portugál), ro (Román), ru (Orosz), sk (Szlovák), sl (Szlovén), sr (Српски), sv (Svéd), tr (Török), uk (Ukrán), zh (Kínai)


A SOAP (3. verzió) változásai a SOAP (2. verzióhoz képest) [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

Új elemek:

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

Webhooks Settings

Áttekintés

A webhook segítségével egy alkalmazás valós idejű információkat szolgáltathat más alkalmazásoknak. A webhook szolgáltatásunk egy URL-címmel konfigurált HTTP visszahívásokat valósít meg. A megadott esemény bekövetkezésekor egy HTTP POST hasznos adatot küldünk erre az URL-címre JSON formátumban. Projektünk keretében a webhook funkciót úgy alakítottuk ki, hogy meghatározott eseményeket váltson ki.

Webhook beállítása

Az alkalmazáshoz tartozó webhook beállításához navigáljon az alkalmazás beállításai oldalra, és keresse meg a "Webhooks Settings" (Webhooks beállítások) részt. És adja meg a következő információkat:

  1. A "Webhook URL" az az URL, ahonnan a kiszolgáló a webhook POST kéréseket fogadja.
  2. A "Delivery max attempts " az a beállítás, amely meghatározza a webhook esemény kézbesítésére tett újbóli próbálkozások maximális számát, ha az első kézbesítési kísérlet sikertelen.
  3. A "Delivery retry timeout" egy olyan beállítás, amely lehetővé teszi, hogy megadja az újbóli próbálkozások közötti időintervallumot, ha egy webhook-kézbesítési kísérlet sikertelen.

Miután megadta ezeket az adatokat, kattintson a "Mentés" gombra.

Webhook eseménytípusok

  1. A megrendelés új állapota

Webhook hasznos teher

Amikor egy esemény bekövetkezik, egy HTTP POST-kérést küldünk a hasznos URL-címre egy JSON-testtel, amely az eseményre vonatkozó információkat tartalmazza.

Íme egy példa a hasznos terhelésre:
A megrendelés új státuszának payload példája
A "new_status" mező lehetséges értékei:
  • "Finished" - a megrendelés teljes. A megrendelés átvehető;
  • "Updated" - egy megbízás frissítése, adatok hozzáadása egy befejezett megbízáshoz;
  • "Canceled" - a megrendelés törlésére a vevő kérésére (vagy beleegyezésével) kerül sor.;
  • "Rejected" - a megrendelést elutasítják. Általában azért, mert lehetetlen azonosítani egy céget..

Webhookok biztosítása

Fontos ellenőrizni, hogy a hasznos URL-címre küldött POST-kérések az alkalmazásunkból származnak-e. Ennek elősegítésére minden webhook-kérelem tartalmaz egy X-Signature fejlécet.

Aláírás Leírás

Az aláíráshoz HMAC-ot használunk SHA512 algoritmussal.

A Secret az App ID és a Secret Key (titkos kulcs ) összekapcsolása a webhooks beállításaiból.

Szükség esetén saját get-paramétereket is hozzáadhat a végponthoz a feladó azonosítása érdekében.

Hibaelhárítás

A kiszolgálónak 10 másodpercen belül válaszolnia kell, és egy 2XX HTTP-kódot kell visszaküldenie; ellenkező esetben a webhook kézbesítése sikertelennek minősül. Sikertelenség esetén a funkció megkísérli a kérés újraküldését a kézbesítési szabályzatnak megfelelően.