Infoproff API dokumentatsioon - v3


Alustamine


Veebiteenuse wsdl ja skeemid asuvad siin:

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

Web service functions:

  • SimpleSearch - Otsige teavet ettevõtete kohta erinevates riikides.
  • ChkFinance - Otsige kättesaadavaid finantsaruandeid.
  • Order - Luuakse order_id ja tagastatakse duplikaadid. Duplikaadid valitakse järgmiste parameetrite järgi: country, product, reg_code.
  • OrderCancellation - Kui olete saatnud tellimuse ja saanud order_id, on teil võimalus see tellimus tühistada (kui see ei ole veel tootmisse läinud).
  • OrderConfirmation - Pärast seda, kui olete saanud order_id, peate oma tellimuse kinnitama 1 tunni jooksul. Kui te ei kinnita oma tellimust 1 tunni jooksul, tühistatakse tellimus automaatselt.
  • ChkStatus - Kontrollige tellimuse staatust.
  • GetReport - Hankige valmis aruanded.

  • GetClassifiersFinancialStatements - Hangib kõik finantsdokumendid kõigi elementidega: row_number, row_formated_description, row_lang_key ja row_order.
  • GetLegalForms - Hangi kõik õiguslikud vormid kõigi olemasolevate riikide jaoks.
  • GetActivityClassificators - Hangi kõik koodid ja kirjeldused konkreetse tegevusala klassifikaatori jaoks.
  • GetDictionaryStandardPhrases - Saate kõik standardfraasid koos võtmete ja keelega.
  • GetAvailableProducts - Hankige nimekiri saadaolevatest toodetest.

  • CreditOpinionCalculator - Krediidihinnangu kalkulaator aitab määrata ettevõtte krediidihinnangut.

API pakub mitmeid teenuseid:

  1. Online-krediidiaruanded järgmiste riikide kohta: Soome (FIN), Rootsi (SWE), Belgia (BEL), Holland (NLD), Eesti (EST)
  2. Offline-aruanded järgmiste riikide kohta: Kõik riigid
  3. Krediidiarvamuse kalkulaator

Kuidas otsida ettevõtet?


Ettevõtte otsing koosneb 2 valikust:

  1. Otsing ettevõtte nime järgi,
  2. Search by company code.
Olemasolevate riikide loetelu: Aserbaidžaan (AZE), Austria (AUT), Belgia (BEL), Eesti (EST), Gruusia (GEO), Gröönimaa (GRL), Hiina (CHN), Hispaania (ESP), Holland (NLD), Iirimaa (IRL), Itaalia (ITA), Kasahstan (KAZ), Kõrgõzstan (KGZ), Küpros (CYP), Moldova (MDA), Mongoolia (MNG), Norra (NOR), Poola (POL), Portugal (PRT), Prantsusmaa (FRA), Rootsi (SWE), Saksamaa (DEU), Soome (FIN), Suurbritannia (GBR), Taani (DNK), Usbekistan (UZB), Valgevene (BLR), Šveits (CHE)
Oluline teave:

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.

Norra register ei võimalda kustutatud äriühingute otsingut nimede järgi. Seetõttu ei saa me Norra kustutatud äriühingute puhul pakkuda SimpleSearch nime järgi.

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

Allpool leiate näite:


Funktsioon SimpleSearch

Võimalus 2: Otsing registreerimiskoodi järgi

Funktsioon SimpleSearch

Kuidas tellida krediidiinfo?


List of available countries for online credit reports: Belgia (BEL), Eesti (EST), Holland (NLD), Kasahstan (KAZ), Kõrgõzstan (KGZ), Poola (POL), Rootsi (SWE), Soome (FIN)
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))

Funktsioon SimpleSearch

To order an Online/Offline with identification report you need to receive "<search_result_id>".
To do so, please follow the link: Kuidas otsida ettevõtet?

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

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

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

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

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

Aruannete puhul kasutatakse järgmisi olekuid:

  • Toimumisel - Aruanne tootmisetapis
  • Canceled - Tühistatud tellimus
  • Finished - Aruanne on valmis
  • Updated - Valmis aruandesse lisati teave
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Meie süsteemis on ilmnenud tehniline viga. See tähendab, et meid on sellest veast teavitatud ja me parandame selle niipea kui võimalik. Teid teavitatakse, kui saate tellimuse kätte.

Kui täitmise staatus on Finished või Updated, siis saate tellimuse.

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

Funktsioon GetReport
Olemasolevate keelte loetelu: bg (Bulgaaria), cs (Tšehhi), da (Taani), de (Saksa), el (Kreeka), en (Inglise), es (Hispaania), et (Eesti), fi (Soome), fr (Prantsuse), hu (Ungari), id (Indoneesia), it (Itaalia), ja (Jaapani), ko (Korea), lt (Leedu), lv (Läti), nb (Norra keel Bokmål), nl (Hollandi), pl (Poola), pt (Portugali), ro (Rumeenia), ru (Venemaa), sk (Slovakkia), sl (Sloveenia), sv (Rootsi), tr (Türgi), uk (Ukraina), zh (Hiina)

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

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

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

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

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

Aruannete puhul kasutatakse järgmisi olekuid:

  • Toimumisel - Aruanne tootmisetapis
  • Canceled - Tühistatud tellimus
  • Finished - Aruanne on valmis
  • Updated - Valmis aruandesse lisati teave
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Meie süsteemis on ilmnenud tehniline viga. See tähendab, et meid on sellest veast teavitatud ja me parandame selle niipea kui võimalik. Teid teavitatakse, kui saate tellimuse kätte.

Kui täitmise staatus on Finished või Updated, siis saate tellimuse.

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

Funktsioon GetReport
Olemasolevate keelte loetelu: bg (Bulgaaria), cs (Tšehhi), da (Taani), de (Saksa), el (Kreeka), en (Inglise), es (Hispaania), et (Eesti), fi (Soome), fr (Prantsuse), hu (Ungari), id (Indoneesia), it (Itaalia), ja (Jaapani), ko (Korea), lt (Leedu), lv (Läti), nb (Norra keel Bokmål), nl (Hollandi), pl (Poola), pt (Portugali), ro (Rumeenia), ru (Venemaa), sk (Slovakkia), sl (Sloveenia), sv (Rootsi), tr (Türgi), uk (Ukraina), zh (Hiina)

Kuidas tellida online finantsaruandeid?


STEP 1: Find a company

Funktsioon SimpleSearch

To order an online financial statements, you need to receive "<search_result_id>".
To do so, please follow the link: Kuidas otsida ettevõtet?

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: Otsida saadaolevaid finantsaruandeid

Funktsioon ChkFinance

Seda funktsiooni on vaja ainult siis, kui tellite toote: finances (Financial statements) koos delivery_term = 'o'.

Olemasolevate riikide loetelu: Eesti (EST), Rootsi (SWE)

STEP 3: Tellida finantsaruanded

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

Funktsioon 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

Funktsioon 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

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

Aruannete puhul kasutatakse järgmisi olekuid:

  • Toimumisel - Aruanne tootmisetapis
  • Canceled - Tühistatud tellimus
  • Finished - Aruanne on valmis
  • Updated - Valmis aruandesse lisati teave
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Meie süsteemis on ilmnenud tehniline viga. See tähendab, et meid on sellest veast teavitatud ja me parandame selle niipea kui võimalik. Teid teavitatakse, kui saate tellimuse kätte.

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

Funktsioon GetReport
Olemasolevate keelte loetelu: bg (Bulgaaria), cs (Tšehhi), da (Taani), de (Saksa), el (Kreeka), en (Inglise), es (Hispaania), et (Eesti), fi (Soome), fr (Prantsuse), hu (Ungari), id (Indoneesia), it (Itaalia), ja (Jaapani), ko (Korea), lt (Leedu), lv (Läti), nb (Norra keel Bokmål), nl (Hollandi), pl (Poola), pt (Portugali), ro (Rumeenia), ru (Venemaa), sk (Slovakkia), sl (Sloveenia), sv (Rootsi), tr (Türgi), uk (Ukraina), zh (Hiina)
To see the examples of xml request/response, please follow the link: How to get finished order?

Kuidas alla laadida standardseid aruandeid (muudes vormingutes peale XML-i)?


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.

Taotlus koosneb 3 osast:

  1. Fikseeritud osa https://www.infoproff.com/en/orders/files/
  2. Teie unikaalne hash, mille me anname vastuseks
  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 - Originaal (vahetuseta), 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

Kuidas alla laadida mittestandardseid tooteid?


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.

Taotlus koosneb 3 osast:

  1. Fixed part https://www.infoproff.com/en/orders/files/
  2. Teie unikaalne hash, mille me anname vastuseks
  3. Ja fikseeritud osa lõpus /download

Kuidas saada krediidihinnangut?


Funktsioon CreditOpinionCalculator

Kuidas saada lisateavet?


Funktsioon GetClassifiersFinancialStatements
Funktsioon GetActivityClassificators
Funktsioon GetDictionaryStandardPhrases
Funktsioon GetAvailableProducts

delivery_term:

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

Võimalikud vead


Need vead võivad ilmneda meie veebiteenusele taotluse esitamisel.


Kõik funktsioonid
  • Incorrect username/password or you have no permissions.
    Te sisestate valed volitused või teie API-juurdepääs on blokeeritud.

Funktsioon SimpleSearch
  1. You don't have permissions to search in this country.
    Olemasolevate riikide loetelu: Aserbaidžaan (AZE), Austria (AUT), Belgia (BEL), Eesti (EST), Gruusia (GEO), Gröönimaa (GRL), Hiina (CHN), Hispaania (ESP), Holland (NLD), Iirimaa (IRL), Itaalia (ITA), Kasahstan (KAZ), Kõrgõzstan (KGZ), Küpros (CYP), Moldova (MDA), Mongoolia (MNG), Norra (NOR), Poola (POL), Portugal (PRT), Prantsusmaa (FRA), Rootsi (SWE), Saksamaa (DEU), Soome (FIN), Suurbritannia (GBR), Taani (DNK), Usbekistan (UZB), Valgevene (BLR), Šveits (CHE)
Funktsioon Order
  1. This product is not available.
    Sellist toodet ei leia ja seda ei ole võimalik tellida.
  2. You can't order report on company with legal form: "legal_form"
    See viga kehtib ainult: Rootsi (SWE)
    Rootsis ei ole võimalik tellida veebipõhist aruannet (delivery_term = "o") koos järgmiste juriidiliste vormidega:
    • 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-aruande tellimisel (delivery_term = "n", "f" või "s") on nõutav "Business Name" või "Reg Code".
  5. Reg Code is required when delivery term is Online
    Kui tellite veebipõhise aruande (delivery_term = "o"), siis on nõutav "Reg Code".

Funktsioon GetReport
  1. This language is not supported.
    Online-aruannete jaoks kättesaadavate keelte loetelu: bg (Bulgaaria), cs (Tšehhi), da (Taani), de (Saksa), el (Kreeka), en (Inglise), es (Hispaania), et (Eesti), fi (Soome), fr (Prantsuse), hu (Ungari), id (Indoneesia), it (Itaalia), ja (Jaapani), ko (Korea), lt (Leedu), lv (Läti), nb (Norra keel Bokmål), nl (Hollandi), pl (Poola), pt (Portugali), ro (Rumeenia), ru (Venemaa), sk (Slovakkia), sl (Sloveenia), sv (Rootsi), tr (Türgi), uk (Ukraina), zh (Hiina)

Funktsioonid GetReport ChkStatus
  1. Incorrect order_id.
    Tellimuse ID-d ei leia. Tellimuse ID saate, kui kasutate funktsiooni Order.

Funktsioon OrderCancellation
  1. Your order is already canceled.
    Teil ei ole enam luba tellimuse tühistamiseks.

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

SOAPi (versioon 3) muudatused võrreldes SOAPiga (versioon 2)


SOAPi (versioon 3) muudatused võrreldes SOAPiga (versioon 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: Aserbaidžaan (AZE), Austria (AUT), Belgia (BEL), Eesti (EST), Gruusia (GEO), Gröönimaa (GRL), Hiina (CHN), Hispaania (ESP), Holland (NLD), Iirimaa (IRL), Itaalia (ITA), Kasahstan (KAZ), Kõrgõzstan (KGZ), Küpros (CYP), Moldova (MDA), Mongoolia (MNG), Norra (NOR), Poola (POL), Portugal (PRT), Prantsusmaa (FRA), Rootsi (SWE), Saksamaa (DEU), Soome (FIN), Suurbritannia (GBR), Taani (DNK), Usbekistan (UZB), Valgevene (BLR), Šveits (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: Belgia (BEL), Eesti (EST), Holland (NLD), Kasahstan (KAZ), Kõrgõzstan (KGZ), Poola (POL), Rootsi (SWE), Soome (FIN)

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

3) Function: GetReport

- Changes in of available languages: bg (Bulgaaria), cs (Tšehhi), da (Taani), de (Saksa), el (Kreeka), en (Inglise), es (Hispaania), et (Eesti), fi (Soome), fr (Prantsuse), hu (Ungari), id (Indoneesia), it (Itaalia), ja (Jaapani), ko (Korea), lt (Leedu), lv (Läti), nb (Norra keel Bokmål), nl (Hollandi), pl (Poola), pt (Portugali), ro (Rumeenia), ru (Venemaa), sk (Slovakkia), sl (Sloveenia), sv (Rootsi), tr (Türgi), uk (Ukraina), zh (Hiina)


SOAPi (versioon 3) muudatused võrreldes SOAPiga (versioon 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

Uued elemendid:

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

Webhooks Settings


Ülevaade

Veebikonks on viis, kuidas rakendus saab teistele rakendustele reaalajas teavet edastada. Meie webhook-funktsioon rakendab HTTP-kõnesid, mis on konfigureeritud URL-i abil. Sellele URL-ile saadetakse JSON-vormingus HTTP POST-saateleht, kui toimub kindlaksmääratud sündmus. Meie projekti kontekstis oleme kujundanud webhook-funktsiooni konkreetsete sündmuste käivitamiseks.

Veebikonksu seadistamine

Veebikonksu seadistamiseks rakenduse jaoks navigeeri rakenduse seadete lehele ja otsi jaotist "Veebikonksude seaded". Ja esitage järgmised andmed:

  1. "Webhook URL" on URL, mille kaudu teie server võtab vastu veebikonksu POST-päringuid.
  2. "Delivery max attempts " on seadistus, mis määrab maksimaalse arvu korduskatseid, mida tuleks teha veebikonksu sündmuse edastamiseks, kui esialgne edastamiskatse ebaõnnestub.
  3. "Delivery retry timeout " on seadistus, mis võimaldab määrata ajavahemiku, mis kulub korduskatsete vahel, kui veebikonksu kättetoimetamise katse ebaõnnestub.

Pärast nende andmete esitamist klõpsake nuppu "Salvesta".

Webhooki sündmuse tüübid

  1. Tellimuse uus staatus

Webhooki kasuliku koormuse

Kui sündmus toimub, saadame HTTP POST päringu tasulise URL-i aadressile koos JSON-korpusega, mis sisaldab teavet sündmuse kohta.

Siin on näide kasuliku koormuse kohta:
Maksukoormuse näide uue tellimuse staatuse kohta
Välja "new_status" võimalikud väärtused:
  • "Finished" - tellimus on täielik. Tellimuse saab kätte;
  • "Updated" - tellimuse ajakohastamine, andmed lisatakse lõpetatud tellimusele;
  • "Canceled" - tellimus tühistatakse kliendi soovil (või nõusolekul).;
  • "Rejected" - tellimus lükatakse tagasi. Tavaliselt seetõttu, et ettevõtet on võimatu tuvastada..

Veebikonksude turvamine

Oluline on kontrollida, et POST päringud, mis saadetakse kasulikule URL-ile, on meie rakendusest. Selle abistamiseks sisaldab iga veebikonksu taotlus X-Signature päise.

Allkiri Kirjeldus

Allkirjastamiseks kasutame HMAC-i ja SHA512 algoritmi.

Saladus on rakenduse ID ja salajase võtme ühendamine veebikonksude seadetest.

Vajaduse korral on võimalik lõpp-punktile lisada oma get-parameetrid saatja tuvastamiseks.

Veaotsing

Server peab vastama 10 sekundi jooksul ja tagastama HTTP-koodi 2XX; vastasel juhul loetakse veebikonksu edastamine ebaõnnestunuks. Ebaõnnestumise korral üritab funktsioon päringut uuesti saata vastavalt tarnepoliitikale.