Dokumentácia API Infoproff - v3


Začíname


Webová služba wsdl a schémy sa nachádzajú tu:

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

Web service functions:

  • SimpleSearch - Vyhľadávanie informácií o spoločnostiach v rôznych krajinách.
  • ChkFinance - Vyhľadajte dostupné finančné výkazy.
  • Order - Vytvorí stránku order_id a vráti duplikáty. Duplikáty sa vyberajú podľa nasledujúcich parametrov: country, product, reg_code.
  • OrderCancellation - Ak ste odoslali žiadosť o objednávku a dostali ste adresu order_id, máte možnosť túto objednávku zrušiť (ak sa ešte nezačala vyrábať).
  • OrderConfirmation - Po získaní adresy order_id budete musieť svoju objednávku potvrdiť do 1 hodiny. Ak objednávku nepotvrdíte do 1 hodiny, objednávka sa automaticky zruší.
  • ChkStatus - Skontrolujte stav objednávky.
  • GetReport - Získajte hotové správy.

  • GetClassifiersFinancialStatements - Získanie všetkých finančných dokladov so všetkými prvkami: číslo_riadku, formátovaný_opis_riadku, kľúč_jazyka_riadku a poradie_riadku.
  • GetLegalForms - Získajte všetky právne formuláre pre všetky dostupné krajiny.
  • GetActivityClassificators - Získajte všetky kódy a popisy pre klasifikátor konkrétnej činnosti.
  • GetDictionaryStandardPhrases - Získajte všetky štandardné frázy s kľúčmi a jazykom.
  • GetAvailableProducts - Získajte zoznam dostupných produktov.

  • CreditOpinionCalculator - Kalkulačka úverového posudku pomáha priradiť úverový posudok spoločnosti.

API poskytuje niekoľko služieb:

  1. Online úverové správy pre nasledujúce krajiny: Fínska republika (FIN), Švédske kráľovstvo (SWE), Belgické kráľovstvo (BEL), Holandské kráľovstvo (NLD), Estónska republika (EST), Kazašská republika (KAZ), Poľská republika (POL), Kirgizská republika (KGZ), Čínska ľudová republika (CHN), Mongolsko (MNG)
  2. Offline správy pre tieto krajiny: Všetky krajiny
  3. Kalkulátor úverových názorov

Ako vyhľadať spoločnosť?


Vyhľadávanie spoločnosti pozostáva z 2 možností:

  1. Vyhľadávanie podľa názvu spoločnosti,
  2. Search by company code.
Zoznam dostupných krajín: Albánska republika (ALB), Alžírska demokratická ľudová republika (DZA), Argentínska republika (ARG), Austrálske spoločenstvo (AUS), Azerbajdžanská republika (AZE), Bailiwick of Jersey (JEY), Belgické kráľovstvo (BEL), Bieloruská republika (BLR), Bosna a Hercegovina (BIH), Brazílska federatívna republika (BRA), Bulharská republika (BGR), Chorvátska republika (HRV), Cyperská republika (CYP), Dánske kráľovstvo (DNK), Ekvádorská republika (ECU), Estónska republika (EST), Francúzska republika (FRA), Fínska republika (FIN), Georgia (GEO), Grónsko (GRL), Helénska republika (GRC), Holandské kráľovstvo (NLD), Hongkong (HKG), Islandská republika (ISL), Izraelský štát (ISR), Japonsko (JPN), Juhoafrická republika (ZAF), Kazašská republika (KAZ), Kirgizská republika (KGZ), Kosovo (XXK), Lichtenštajnské kniežatstvo (LIE), Lotyšská republika (LVA), Luxemburské veľkovojvodstvo (LUX), Maldivská republika (MDV), Maltská republika (MLT), Marocké kráľovstvo (MAR), Maďarská republika (HUN), Moldavská republika (MDA), Monacké kniežatstvo (MCO), Mongolsko (MNG), Nezávislý štát Samoa (WSM), Nový Zéland (NZL), Nórske kráľovstvo (NOR), Ostrov Man (IMN), Paraguajská republika (PRY), Portugalská republika (PRT), Poľská republika (POL), Rakúska republika (AUT), Rumunsko (ROU), Ruská federácia (RUS), Sanmarínska republika (SMR), Seychelská republika (SYC), Singapurská republika (SGP), Slovenská republika (SVK), Slovinská republika (SVN), Spojené arabské emiráty (ARE), Spojené kráľovstvo Veľkej Británie a Severného Írska (GBR), Spolková republika Nemecko (DEU), Srbská republika (SRB), Tadžická republika (TJK), Talianska republika (ITA), Uzbecká republika (UZB), Írsko (IRL), Česká republika (CZE), Čínska republika (TWN), Čínska ľudová republika (CHN), Španielske kráľovstvo (ESP), Švajčiarska konfederácia (CHE), Švédske kráľovstvo (SWE)
Dôležité informácie:

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.

Nórsky register neumožňuje vyhľadávať vymazané spoločnosti podľa názvov. Preto nemôžeme poskytnúť SimpleSearch podľa názvov v rámci vymazaných spoločností v Nórsku.

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

Nižšie nájdete príklad:


Funkcia SimpleSearch

Možnosť 2: Vyhľadávanie podľa registračného kódu

Funkcia SimpleSearch

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

Funkcia UnifiedSearch

Ako si objednať úverovú správu?


List of available countries for online credit reports: Belgické kráľovstvo (BEL), Estónska republika (EST), Fínska republika (FIN), Holandské kráľovstvo (NLD), Kazašská republika (KAZ), Kirgizská republika (KGZ), Mongolsko (MNG), Poľská republika (POL), Ruská federácia (RUS), Čínska ľudová republika (CHN), Švédske kráľovstvo (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))

Funkcia SimpleSearch

To order an Online/Offline with identification report you need to receive "<search_result_id>".
To do so, please follow the link: Ako vyhľadať spoločnosť?

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

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

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

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

Funkcia 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.

Pre hlásenia sa používajú tieto stavy:

  • Prebieha - Správa vo fáze výroby
  • Canceled - Zrušená objednávka
  • Finished - Správa je pripravená
  • Updated - Do hotovej správy boli doplnené informácie
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - V našom systéme došlo k technickej chybe. To znamená, že sme o tejto chybe informovaní a čo najskôr ju opravíme. O tom, kedy budete môcť objednávku prijať, vás budeme informovať.

Ak je stav vykonania Finished alebo Updated, potom môžete získať príkaz.

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

Funkcia GetReport
Zoznam dostupných jazykov: bg (Bulharský), cs (Český), da (Dánsky), de (Nemčina), el (Grécky), en (Angličtina), es (Španielčina), et (Estónčina), fi (Fínsky), fr (Francúzsky), hu (Maďarský), id (Indonézsky), it (Taliansky), ja (Japonský), ko (Kórejský), lt (Litovský), lv (Lotyšský), nb (Nórsky jazyk Bokmål), nl (Holandský), pl (Poľský), pt (Portugalčina), ro (Rumunský), ru (Ruský), sk (Slovenská), sl (Slovinčina), sr (Српски), sv (Švédsky), tr (Turecký), uk (Ukrajinský), zh (Čínsky)

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

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

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

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

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

Pre hlásenia sa používajú tieto stavy:

  • Prebieha - Správa vo fáze výroby
  • Canceled - Zrušená objednávka
  • Finished - Správa je pripravená
  • Updated - Do hotovej správy boli doplnené informácie
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - V našom systéme došlo k technickej chybe. To znamená, že sme o tejto chybe informovaní a čo najskôr ju opravíme. O tom, kedy budete môcť objednávku prijať, vás budeme informovať.

Ak je stav vykonania Finished alebo Updated, potom môžete získať príkaz.

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

Funkcia GetReport
Zoznam dostupných jazykov: bg (Bulharský), cs (Český), da (Dánsky), de (Nemčina), el (Grécky), en (Angličtina), es (Španielčina), et (Estónčina), fi (Fínsky), fr (Francúzsky), hu (Maďarský), id (Indonézsky), it (Taliansky), ja (Japonský), ko (Kórejský), lt (Litovský), lv (Lotyšský), nb (Nórsky jazyk Bokmål), nl (Holandský), pl (Poľský), pt (Portugalčina), ro (Rumunský), ru (Ruský), sk (Slovenská), sl (Slovinčina), sr (Српски), sv (Švédsky), tr (Turecký), uk (Ukrajinský), zh (Čínsky)

Ako si objednať finančné výkazy online?


STEP 1: Find a company

Funkcia SimpleSearch

To order an online financial statements, you need to receive "<search_result_id>".
To do so, please follow the link: Ako vyhľadať spoločnosť?

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: Vyhľadávanie dostupných finančných výkazov

Funkcia ChkFinance

Táto funkcia je potrebná len pri objednávaní produktu: finances (Financial statements) s delivery_term = 'o'.

Zoznam dostupných krajín: Estónska republika (EST), Švédske kráľovstvo (SWE)

STEP 3: Objednávka finančných výkazov

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

Funkcia 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

Funkcia 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

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

Pre hlásenia sa používajú tieto stavy:

  • Prebieha - Správa vo fáze výroby
  • Canceled - Zrušená objednávka
  • Finished - Správa je pripravená
  • Updated - Do hotovej správy boli doplnené informácie
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - V našom systéme došlo k technickej chybe. To znamená, že sme o tejto chybe informovaní a čo najskôr ju opravíme. O tom, kedy budete môcť objednávku prijať, vás budeme informovať.

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

Funkcia GetReport
Zoznam dostupných jazykov: bg (Bulharský), cs (Český), da (Dánsky), de (Nemčina), el (Grécky), en (Angličtina), es (Španielčina), et (Estónčina), fi (Fínsky), fr (Francúzsky), hu (Maďarský), id (Indonézsky), it (Taliansky), ja (Japonský), ko (Kórejský), lt (Litovský), lv (Lotyšský), nb (Nórsky jazyk Bokmål), nl (Holandský), pl (Poľský), pt (Portugalčina), ro (Rumunský), ru (Ruský), sk (Slovenská), sl (Slovinčina), sr (Српски), sv (Švédsky), tr (Turecký), uk (Ukrajinský), zh (Čínsky)
To see the examples of xml request/response, please follow the link: How to get finished order?

Ako stiahnuť štandardné zostavy (v iných formátoch ako 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.

Žiadosť pozostáva z 3 častí:

  1. Pevná časť https://www.infoproff.com/en/orders/files/
  2. Váš jedinečný hash, ktorý poskytujeme ako odpoveď
  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 - Originál (bez výmeny), 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

Ako stiahnuť neštandardné produkty?


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.

Žiadosť pozostáva z 3 častí:

  1. Fixed part https://www.infoproff.com/en/orders/files/
  2. Váš jedinečný hash, ktorý poskytujeme ako odpoveď
  3. A pevná časť na konci /download

Ako získať úverové stanovisko?


Funkcia CreditOpinionCalculator

Ako získať ďalšie informácie?


Funkcia GetClassifiersFinancialStatements
Funkcia GetActivityClassificators
Funkcia GetDictionaryStandardPhrases
Funkcia GetAvailableProducts

delivery_term:

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

Možné chyby


Tieto chyby sa môžu vyskytnúť pri zadávaní požiadavky na našu webovú službu.


Všetky funkcie
  • Incorrect username/password or you have no permissions.
    Zadávate nesprávne poverenia alebo je váš prístup k API zablokovaný.

Funkcia SimpleSearch
  1. You don't have permissions to search in this country.
    Zoznam dostupných krajín: Albánska republika (ALB), Alžírska demokratická ľudová republika (DZA), Argentínska republika (ARG), Austrálske spoločenstvo (AUS), Azerbajdžanská republika (AZE), Bailiwick of Jersey (JEY), Belgické kráľovstvo (BEL), Bieloruská republika (BLR), Bosna a Hercegovina (BIH), Brazílska federatívna republika (BRA), Bulharská republika (BGR), Chorvátska republika (HRV), Cyperská republika (CYP), Dánske kráľovstvo (DNK), Ekvádorská republika (ECU), Estónska republika (EST), Francúzska republika (FRA), Fínska republika (FIN), Georgia (GEO), Grónsko (GRL), Helénska republika (GRC), Holandské kráľovstvo (NLD), Hongkong (HKG), Islandská republika (ISL), Izraelský štát (ISR), Japonsko (JPN), Juhoafrická republika (ZAF), Kazašská republika (KAZ), Kirgizská republika (KGZ), Kosovo (XXK), Lichtenštajnské kniežatstvo (LIE), Lotyšská republika (LVA), Luxemburské veľkovojvodstvo (LUX), Maldivská republika (MDV), Maltská republika (MLT), Marocké kráľovstvo (MAR), Maďarská republika (HUN), Moldavská republika (MDA), Monacké kniežatstvo (MCO), Mongolsko (MNG), Nezávislý štát Samoa (WSM), Nový Zéland (NZL), Nórske kráľovstvo (NOR), Ostrov Man (IMN), Paraguajská republika (PRY), Portugalská republika (PRT), Poľská republika (POL), Rakúska republika (AUT), Rumunsko (ROU), Ruská federácia (RUS), Sanmarínska republika (SMR), Seychelská republika (SYC), Singapurská republika (SGP), Slovenská republika (SVK), Slovinská republika (SVN), Spojené arabské emiráty (ARE), Spojené kráľovstvo Veľkej Británie a Severného Írska (GBR), Spolková republika Nemecko (DEU), Srbská republika (SRB), Tadžická republika (TJK), Talianska republika (ITA), Uzbecká republika (UZB), Írsko (IRL), Česká republika (CZE), Čínska republika (TWN), Čínska ľudová republika (CHN), Španielske kráľovstvo (ESP), Švajčiarska konfederácia (CHE), Švédske kráľovstvo (SWE)
Funkcia Order
  1. This product is not available.
    Takýto výrobok nie je možné nájsť a nie je možné ho objednať.
  2. You can't order report on company with legal form: "legal_form"
    Táto chyba sa týka len: Švédske kráľovstvo (SWE)
    Vo Švédsku nie je možné objednať online správu (delivery_term = "o") s ďalšími právnymi formulármi:
    • 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
    Pri objednávaní offline správy (delivery_term = "n", "f" alebo "s") sa vyžaduje "Obchodné meno" alebo "Reg. kód".
  5. Reg Code is required when delivery term is Online
    Pri objednávaní online správy (delivery_term = "o") sa vyžaduje "Reg Code".

Funkcia GetReport
  1. This language is not supported.
    Zoznam dostupných jazykov pre online správy: bg (Bulharský), cs (Český), da (Dánsky), de (Nemčina), el (Grécky), en (Angličtina), es (Španielčina), et (Estónčina), fi (Fínsky), fr (Francúzsky), hu (Maďarský), id (Indonézsky), it (Taliansky), ja (Japonský), ko (Kórejský), lt (Litovský), lv (Lotyšský), nb (Nórsky jazyk Bokmål), nl (Holandský), pl (Poľský), pt (Portugalčina), ro (Rumunský), ru (Ruský), sk (Slovenská), sl (Slovinčina), sr (Српски), sv (Švédsky), tr (Turecký), uk (Ukrajinský), zh (Čínsky)

Funkcie GetReport ChkStatus
  1. Incorrect order_id.
    ID objednávky sa nedá nájsť. ID objednávky získate, keď použijete funkciu Order.

Funkcia OrderCancellation
  1. Your order is already canceled.
    Už nemáte povolenie zrušiť objednávku.

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

Zmeny v SOAP (verzia 3) v porovnaní so SOAP (verzia 2)


Zmeny v SOAP (verzia 3) v porovnaní so SOAP (verzia 2) [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: Albánska republika (ALB), Alžírska demokratická ľudová republika (DZA), Argentínska republika (ARG), Austrálske spoločenstvo (AUS), Azerbajdžanská republika (AZE), Bailiwick of Jersey (JEY), Belgické kráľovstvo (BEL), Bieloruská republika (BLR), Bosna a Hercegovina (BIH), Brazílska federatívna republika (BRA), Bulharská republika (BGR), Chorvátska republika (HRV), Cyperská republika (CYP), Dánske kráľovstvo (DNK), Ekvádorská republika (ECU), Estónska republika (EST), Francúzska republika (FRA), Fínska republika (FIN), Georgia (GEO), Grónsko (GRL), Helénska republika (GRC), Holandské kráľovstvo (NLD), Hongkong (HKG), Islandská republika (ISL), Izraelský štát (ISR), Japonsko (JPN), Juhoafrická republika (ZAF), Kazašská republika (KAZ), Kirgizská republika (KGZ), Kosovo (XXK), Lichtenštajnské kniežatstvo (LIE), Lotyšská republika (LVA), Luxemburské veľkovojvodstvo (LUX), Maldivská republika (MDV), Maltská republika (MLT), Marocké kráľovstvo (MAR), Maďarská republika (HUN), Moldavská republika (MDA), Monacké kniežatstvo (MCO), Mongolsko (MNG), Nezávislý štát Samoa (WSM), Nový Zéland (NZL), Nórske kráľovstvo (NOR), Ostrov Man (IMN), Paraguajská republika (PRY), Portugalská republika (PRT), Poľská republika (POL), Rakúska republika (AUT), Rumunsko (ROU), Ruská federácia (RUS), Sanmarínska republika (SMR), Seychelská republika (SYC), Singapurská republika (SGP), Slovenská republika (SVK), Slovinská republika (SVN), Spojené arabské emiráty (ARE), Spojené kráľovstvo Veľkej Británie a Severného Írska (GBR), Spolková republika Nemecko (DEU), Srbská republika (SRB), Tadžická republika (TJK), Talianska republika (ITA), Uzbecká republika (UZB), Írsko (IRL), Česká republika (CZE), Čínska republika (TWN), Čínska ľudová republika (CHN), Španielske kráľovstvo (ESP), Švajčiarska konfederácia (CHE), Švédske kráľovstvo (SWE)

- 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: Belgické kráľovstvo (BEL), Estónska republika (EST), Fínska republika (FIN), Holandské kráľovstvo (NLD), Kazašská republika (KAZ), Kirgizská republika (KGZ), Mongolsko (MNG), Poľská republika (POL), Ruská federácia (RUS), Čínska ľudová republika (CHN), Švédske kráľovstvo (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 (Bulharský), cs (Český), da (Dánsky), de (Nemčina), el (Grécky), en (Angličtina), es (Španielčina), et (Estónčina), fi (Fínsky), fr (Francúzsky), hu (Maďarský), id (Indonézsky), it (Taliansky), ja (Japonský), ko (Kórejský), lt (Litovský), lv (Lotyšský), nb (Nórsky jazyk Bokmål), nl (Holandský), pl (Poľský), pt (Portugalčina), ro (Rumunský), ru (Ruský), sk (Slovenská), sl (Slovinčina), sr (Српски), sv (Švédsky), tr (Turecký), uk (Ukrajinský), zh (Čínsky)


Zmeny v SOAP (verzia 3) v porovnaní so SOAP (verzia 2) [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

Nové prvky:

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

Webhooks Settings


Prehľad

Webhook je spôsob, akým môže aplikácia poskytovať iným aplikáciám informácie v reálnom čase. Naša funkcia webhook implementuje spätné volania HTTP nakonfigurované pomocou adresy URL. Na túto adresu URL sa odošle užitočné zaťaženie HTTP POST vo formáte JSON vždy, keď nastane určitá udalosť. V kontexte nášho projektu sme funkciu webhook navrhli tak, aby spúšťala konkrétne udalosti.

Nastavenie webového háčika

Ak chcete nastaviť webový háčik pre svoju aplikáciu, prejdite na stránku s nastaveniami aplikácie a vyhľadajte časť "Nastavenia webových háčikov". A zadajte nasledujúce informácie:

  1. "Adresa URL webhooku" je adresa URL, na ktorú bude váš server prijímať požiadavky POST webhooku.
  2. "Delivery max attempts" je nastavenie, ktoré definuje maximálny počet opakovaných pokusov, ktoré by sa mali vykonať pri doručení udalosti webhooku, keď prvý pokus o doručenie zlyhá.
  3. "Časový limit opakovania doručenia " je nastavenie, ktoré umožňuje určiť časový interval medzi opakovanými pokusmi, keď pokus o doručenie webhooku zlyhá.

Po zadaní týchto údajov kliknite na "Uložiť".

Typy udalostí Webhook

  1. Nový stav objednávky

Webhook Payload

Keď nastane udalosť, odošleme požiadavku HTTP POST na adresu URL užitočného zaťaženia s telom JSON obsahujúcim informácie o udalosti.

Tu je príklad užitočného zaťaženia:
Príklad užitočného zaťaženia nového stavu objednávky
Možné hodnoty poľa "new_status":
  • "Finished" - objednávka je dokončená. Objednávku je možné vyzdvihnúť;
  • "Updated" - aktualizovaná objednávka, údaje pridané do dokončenej objednávky;
  • "Canceled" - objednávka je zrušená na žiadosť (alebo so súhlasom) zákazníka.;
  • "Rejected" - objednávka sa zamietne. Zvyčajne preto, že nie je možné identifikovať spoločnosť.

Zabezpečenie webových háčikov

Je dôležité overiť, či požiadavky POST odoslané na adresu URL užitočného zaťaženia pochádzajú z našej aplikácie. Na pomoc pri tom každá požiadavka webhooku obsahuje hlavičku X-Signature.

Popis podpisu

Na podpisovanie používame HMAC s algoritmom SHA512.

Tajné je spojenie ID aplikácie a tajného kľúča z nastavení webhooku.

V prípade potreby je možné pridať do koncového bodu vlastné parametre get na identifikáciu odosielateľa.

Riešenie problémov

Server musí odpovedať do 10 sekúnd a vrátiť kód HTTP 2XX, inak sa doručenie webhooku považuje za neúspešné. V prípade zlyhania sa funkcia pokúsi o opätovné odoslanie požiadavky podľa zásad doručovania.