Dokumentace API Infoproff - v3


Začínáme


Webové služby wsdl a schémata jsou umístěny zde:

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

Web service functions:

  • SimpleSearch - Vyhledávání informací o společnostech v různých zemích.
  • ChkFinance - Vyhledejte dostupné finanční výkazy.
  • Order - Vytvoří adresu order_id a vrátí duplikáty. Duplikáty se vybírají podle dalších parametrů: country, product, reg_code.
  • OrderCancellation - Pokud jste odeslali požadavek na objednávku a obdrželi jste adresu order_id, máte možnost tuto objednávku zrušit (pokud není zadána do výroby).
  • OrderConfirmation - Po obdržení adresy order_id budete muset objednávku do 1 hodiny potvrdit. Pokud objednávku nepotvrdíte do 1 hodiny, bude automaticky zrušena.
  • ChkStatus - Zkontrolujte stav objednávky.
  • GetReport - Získejte hotové zprávy.

  • GetClassifiersFinancialStatements - Získat všechny finanční doklady se všemi prvky: číslo_řádku, formátovaný_popis_řádku, klíč_jazyka_řádku a pořadí_řádku.
  • GetLegalForms - Získejte všechny právní formuláře pro všechny dostupné země.
  • GetActivityClassificators - Získejte všechny kódy a popisy pro konkrétní klasifikátor činností.
  • GetDictionaryStandardPhrases - Získejte všechny standardní fráze s klíči a jazykem.
  • GetAvailableProducts - Získejte seznam dostupných produktů.

  • CreditOpinionCalculator - Kalkulátor úvěrového posudku pomáhá přiřadit společnosti úvěrový posudek.

API poskytuje několik služeb:

  1. Online úvěrové zprávy pro následující země: Finská republika (FIN), Švédské království (SWE), Belgické království (BEL), Nizozemské království (NLD), Estonská republika (EST)
  2. Offline zprávy pro následující země: Všechny země
  3. Kalkulátor úvěrových názorů

Jak vyhledat společnost?


Hledání společnosti se skládá ze 2 možností:

  1. Vyhledávání podle názvu společnosti,
  2. Search by company code.
Seznam dostupných zemí: Belgické království (BEL), Běloruská republika (BLR), Dánské království (DNK), Estonská republika (EST), Finská republika (FIN), Francouzská republika (FRA), Georgia (GEO), Grónsko (GRL), Irsko (IRL), Italská republika (ITA), Kyperská republika (CYP), Kyrgyzská republika (KGZ), Moldavská republika (MDA), Mongolsko (MNG), Nizozemské království (NLD), Norské království (NOR), Polská republika (POL), Portugalská republika (PRT), Rakouská republika (AUT), Republika Kazachstán (KAZ), Spojené království Velké Británie a Severního Irska (GBR), Spolková republika Německo (DEU), Uzbecká republika (UZB), Ázerbájdžánská republika (AZE), Čínská lidová republika (CHN), Španělské království (ESP), Švédské království (SWE), Švýcarská konfederace (CHE)
Důležité informace:

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.

Norský rejstřík neumožňuje vyhledávat vymazané společnosti podle názvů. Proto nemůžeme poskytnout SimpleSearch podle názvů v rámci vymazaných společností v Norsku.

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

Níže naleznete příklad:


Funkce SimpleSearch

Možnost 2: Vyhledávání podle registračního kódu

Funkce SimpleSearch

Jak si objednat úvěrovou zprávu?


List of available countries for online credit reports: Belgické království (BEL), Estonská republika (EST), Finská republika (FIN), Kyrgyzská republika (KGZ), Nizozemské království (NLD), Polská republika (POL), Republika Kazachstán (KAZ), Švédské království (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))

Funkce SimpleSearch

To order an Online/Offline with identification report you need to receive "<search_result_id>".
To do so, please follow the link: Jak vyhledat společnost?

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

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

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

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

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

Pro hlášení se používají následující stavy:

  • Probíhá - Zpráva ve fázi výroby
  • Canceled - Zrušená objednávka
  • Finished - Zpráva je připravena
  • Updated - Do hotové zprávy byly doplněny informace
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - V našem systému došlo k technické chybě. To znamená, že jsme o této chybě informováni a co nejdříve ji opravíme. O tom, kdy budete moci objednávku obdržet, budete informováni.

Pokud je stav provedení Finished nebo Updated, můžete získat příkaz.

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

Funkce GetReport
Seznam dostupných jazyků: bg (Bulharský), cs (Česky), da (Dánský), de (Němčina), el (Řecký), en (Angličtina), es (Španělština), et (Estonština), fi (Finsko), fr (Francouzština), hu (Maďarština), id (Indonéský), it (Italský), ja (Japonský), ko (Korejský), lt (Litevština), lv (Lotyšský), nb (Norský jazyk Bokmål), nl (Holandský), pl (Polský), pt (Portugalština), ro (Rumunština), ru (Ruský), sk (Slovenská), sl (Slovinština), sv (Švédský), tr (Turecký), uk (Ukrajinský), zh (Čínština)

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

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

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

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

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

Pro hlášení se používají následující stavy:

  • Probíhá - Zpráva ve fázi výroby
  • Canceled - Zrušená objednávka
  • Finished - Zpráva je připravena
  • Updated - Do hotové zprávy byly doplněny informace
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - V našem systému došlo k technické chybě. To znamená, že jsme o této chybě informováni a co nejdříve ji opravíme. O tom, kdy budete moci objednávku obdržet, budete informováni.

Pokud je stav provedení Finished nebo Updated, můžete získat příkaz.

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

Funkce GetReport
Seznam dostupných jazyků: bg (Bulharský), cs (Česky), da (Dánský), de (Němčina), el (Řecký), en (Angličtina), es (Španělština), et (Estonština), fi (Finsko), fr (Francouzština), hu (Maďarština), id (Indonéský), it (Italský), ja (Japonský), ko (Korejský), lt (Litevština), lv (Lotyšský), nb (Norský jazyk Bokmål), nl (Holandský), pl (Polský), pt (Portugalština), ro (Rumunština), ru (Ruský), sk (Slovenská), sl (Slovinština), sv (Švédský), tr (Turecký), uk (Ukrajinský), zh (Čínština)

Jak objednat účetní výkazy online?


STEP 1: Find a company

Funkce SimpleSearch

To order an online financial statements, you need to receive "<search_result_id>".
To do so, please follow the link: Jak vyhledat společnost?

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: Vyhledávání dostupných finančních výkazů

Funkce ChkFinance

Tato funkce je nutná pouze při objednávání produktu: finances (Financial statements) s delivery_term = 'o'.

Seznam dostupných zemí: Estonská republika (EST), Švédské království (SWE)

STEP 3: Objednávka finančních výkazů

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

Funkce 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

Funkce 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

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

Pro hlášení se používají následující stavy:

  • Probíhá - Zpráva ve fázi výroby
  • Canceled - Zrušená objednávka
  • Finished - Zpráva je připravena
  • Updated - Do hotové zprávy byly doplněny informace
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - V našem systému došlo k technické chybě. To znamená, že jsme o této chybě informováni a co nejdříve ji opravíme. O tom, kdy budete moci objednávku obdržet, budete informováni.

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

Funkce GetReport
Seznam dostupných jazyků: bg (Bulharský), cs (Česky), da (Dánský), de (Němčina), el (Řecký), en (Angličtina), es (Španělština), et (Estonština), fi (Finsko), fr (Francouzština), hu (Maďarština), id (Indonéský), it (Italský), ja (Japonský), ko (Korejský), lt (Litevština), lv (Lotyšský), nb (Norský jazyk Bokmål), nl (Holandský), pl (Polský), pt (Portugalština), ro (Rumunština), ru (Ruský), sk (Slovenská), sl (Slovinština), sv (Švédský), tr (Turecký), uk (Ukrajinský), zh (Čínština)
To see the examples of xml request/response, please follow the link: How to get finished order?

Jak stáhnout standardní sestavy (v jiných formátech než 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.

Žádost se skládá ze 3 částí:

  1. Pevná část https://www.infoproff.com/en/orders/files/
  2. Váš jedinečný hash, který poskytneme jako odpověď.
  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 - Původní (bez výměny), 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

Jak stáhnout nestandardní 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.

Žádost se skládá ze 3 částí:

  1. Fixed part https://www.infoproff.com/en/orders/files/
  2. Váš jedinečný hash, který poskytneme jako odpověď.
  3. A pevná část na konci /download

Jak získat úvěrové stanovisko?


Funkce CreditOpinionCalculator

Jak získat další informace?


Funkce GetClassifiersFinancialStatements
Funkce GetActivityClassificators
Funkce GetDictionaryStandardPhrases
Funkce GetAvailableProducts

delivery_term:

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

Možné chyby


Tyto chyby se mohou vyskytnout při zadávání požadavku na naši webovou službu..


Všechny funkce
  • Incorrect username/password or you have no permissions.
    Zadáváte špatné pověření nebo je váš přístup k rozhraní API zablokován.

Funkce SimpleSearch
  1. You don't have permissions to search in this country.
    Seznam dostupných zemí: Belgické království (BEL), Běloruská republika (BLR), Dánské království (DNK), Estonská republika (EST), Finská republika (FIN), Francouzská republika (FRA), Georgia (GEO), Grónsko (GRL), Irsko (IRL), Italská republika (ITA), Kyperská republika (CYP), Kyrgyzská republika (KGZ), Moldavská republika (MDA), Mongolsko (MNG), Nizozemské království (NLD), Norské království (NOR), Polská republika (POL), Portugalská republika (PRT), Rakouská republika (AUT), Republika Kazachstán (KAZ), Spojené království Velké Británie a Severního Irska (GBR), Spolková republika Německo (DEU), Uzbecká republika (UZB), Ázerbájdžánská republika (AZE), Čínská lidová republika (CHN), Španělské království (ESP), Švédské království (SWE), Švýcarská konfederace (CHE)
Funkce Order
  1. This product is not available.
    Takový produkt nelze nalézt a není možné jej objednat.
  2. You can't order report on company with legal form: "legal_form"
    Tato chyba se týká pouze: Švédské království (SWE)
    Ve Švédsku není možné objednat online zprávu (delivery_term = "o") s dalšími právními formuláři:
    • 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
    Při objednávání offline hlášení (delivery_term = "n", "f" nebo "s") je vyžadován "Business Name" nebo "Reg Code".
  5. Reg Code is required when delivery term is Online
    Při objednávání online zprávy (delivery_term = "o") je vyžadován "Reg Code".

Funkce GetReport
  1. This language is not supported.
    Seznam dostupných jazyků pro online zprávy: bg (Bulharský), cs (Česky), da (Dánský), de (Němčina), el (Řecký), en (Angličtina), es (Španělština), et (Estonština), fi (Finsko), fr (Francouzština), hu (Maďarština), id (Indonéský), it (Italský), ja (Japonský), ko (Korejský), lt (Litevština), lv (Lotyšský), nb (Norský jazyk Bokmål), nl (Holandský), pl (Polský), pt (Portugalština), ro (Rumunština), ru (Ruský), sk (Slovenská), sl (Slovinština), sv (Švédský), tr (Turecký), uk (Ukrajinský), zh (Čínština)

Funkce GetReport ChkStatus
  1. Incorrect order_id.
    ID objednávky nelze nalézt. ID objednávky získáte při použití funkce Order.

Funkce OrderCancellation
  1. Your order is already canceled.
    Ke zrušení objednávky již nemáte oprávnění.

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

Změny v protokolu SOAP (verze 3) ve srovnání s protokolem SOAP (verze 2)


Změny v protokolu SOAP (verze 3) ve srovnání s protokolem SOAP (verze 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: Belgické království (BEL), Běloruská republika (BLR), Dánské království (DNK), Estonská republika (EST), Finská republika (FIN), Francouzská republika (FRA), Georgia (GEO), Grónsko (GRL), Irsko (IRL), Italská republika (ITA), Kyperská republika (CYP), Kyrgyzská republika (KGZ), Moldavská republika (MDA), Mongolsko (MNG), Nizozemské království (NLD), Norské království (NOR), Polská republika (POL), Portugalská republika (PRT), Rakouská republika (AUT), Republika Kazachstán (KAZ), Spojené království Velké Británie a Severního Irska (GBR), Spolková republika Německo (DEU), Uzbecká republika (UZB), Ázerbájdžánská republika (AZE), Čínská lidová republika (CHN), Španělské království (ESP), Švédské království (SWE), Švýcarská konfederace (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: Belgické království (BEL), Estonská republika (EST), Finská republika (FIN), Kyrgyzská republika (KGZ), Nizozemské království (NLD), Polská republika (POL), Republika Kazachstán (KAZ), Švédské království (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 (Česky), da (Dánský), de (Němčina), el (Řecký), en (Angličtina), es (Španělština), et (Estonština), fi (Finsko), fr (Francouzština), hu (Maďarština), id (Indonéský), it (Italský), ja (Japonský), ko (Korejský), lt (Litevština), lv (Lotyšský), nb (Norský jazyk Bokmål), nl (Holandský), pl (Polský), pt (Portugalština), ro (Rumunština), ru (Ruský), sk (Slovenská), sl (Slovinština), sv (Švédský), tr (Turecký), uk (Ukrajinský), zh (Čínština)


Změny v protokolu SOAP (verze 3) ve srovnání s protokolem SOAP (verze 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


Přehled

Webový háček je způsob, jak může aplikace poskytovat ostatním aplikacím informace v reálném čase. Naše funkce webhook implementuje zpětná volání HTTP nakonfigurovaná pomocí adresy URL. Na tuto adresu URL je odesláno užitečné zatížení HTTP POST ve formátu JSON, kdykoli dojde k určité události. V kontextu našeho projektu jsme funkci webhook navrhli tak, aby spouštěla konkrétní události.

Nastavení webového háčku

Chcete-li pro svou aplikaci nastavit webový háček, přejděte na stránku nastavení aplikace a vyhledejte část "Nastavení webových háčků". A zadejte následující informace:

  1. "Adresa URL webhooku " je adresa URL, na kterou bude server přijímat požadavky POST webhooku.
  2. "Delivery max attempts " je nastavení, které definuje maximální počet opakovaných pokusů o doručení události webhooku, pokud první pokus o doručení selže.
  3. "Časový limit opakování doručení " je nastavení, které umožňuje určit časový interval mezi opakovanými pokusy o doručení, pokud se pokus o doručení webhooku nezdaří.

Po zadání těchto údajů klikněte na tlačítko "Uložit".

Typy událostí Webhook

  1. Nový stav objednávky

Zatížení webového háčku

Když dojde k události, odešleme na adresu URL užitečného zatížení požadavek HTTP POST s tělem JSON obsahujícím informace o události.

Zde je příklad užitečného zatížení:
Příklad užitečného zatížení nového stavu objednávky
Možné hodnoty pole "new_status":
  • "Finished" - objednávka je dokončena. Objednávku lze vyzvednout;
  • "Updated" - aktualizace objednávky, přidání údajů do dokončené objednávky.;
  • "Canceled" - objednávka je zrušena na žádost (nebo se souhlasem) zákazníka.;
  • "Rejected" - objednávka je zamítnuta. Obvykle proto, že společnost nelze identifikovat..

Zabezpečení webových háčků

Je důležité ověřit, že požadavky POST odeslané na adresu URL užitečného zatížení pocházejí z naší aplikace. K tomu slouží hlavička X-Signature, kterou obsahuje každý požadavek na webhook.

Popis podpisu

Pro podepisování používáme HMAC s algoritmem SHA512.

Secret je součet ID aplikace a Secret Key z nastavení webhooku.

V případě potřeby je možné do koncového bodu přidat vlastní parametry get pro identifikaci odesílatele.

Řešení problémů

Server musí odpovědět do 10 sekund a vrátit kód HTTP 2XX, jinak je doručení webhooku považováno za neúspěšné. V případě neúspěchu se funkce pokusí požadavek znovu odeslat až podle zásad doručování.