Документация за API на Infoproff - v3


Започване на работа


Уеб услугата wsdl и схемите се намират тук:

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

Web service functions:

  • SimpleSearch - Търсене на информация за компании в различни държави.
  • ChkFinance - Търсене на налични финансови отчети.
  • Order - Създава order_id и връща дубликати. Дубликатите се избират по следващите параметри: country, product, reg_code.
  • OrderCancellation - Ако сте изпратили заявка за поръчка и сте получили order_id, имате възможност да отмените тази поръчка (ако тя не е влязла в производство).
  • OrderConfirmation - След като получите order_id, ще трябва да потвърдите поръчката си в рамките на 1 час. Ако не потвърдите поръчката си в рамките на 1 час, тя ще бъде отменена автоматично.
  • ChkStatus - Проверете състоянието на поръчката.
  • GetReport - Получаване на завършени доклади.

  • GetClassifiersFinancialStatements - Получаване на всички финансови документи с всички елементи: row_number, row_formated_description, row_lang_key и row_order.
  • GetLegalForms - Получете всички правни формуляри за всички налични държави.
  • GetActivityClassificators - Получаване на всички кодове и описания за конкретен класификатор на дейности.
  • GetDictionaryStandardPhrases - Получете всички стандартни фрази с ключове и език.
  • GetAvailableProducts - Получете списък с наличните продукти.

  • CreditOpinionCalculator - Калкулаторът за кредитно становище помага да се определи кредитно становище за дадена компания.

API предоставя няколко услуги:

  1. Онлайн кредитни доклади за следните държави: Република Финландия (FIN), Кралство Швеция (SWE), Кралство Белгия (BEL), Кралство Нидерландия (NLD), Република Естония (EST)
  2. Офлайн доклади за следните държави: Всички държави
  3. Калкулатор на кредитното мнение

Как да търсим компания?


Търсенето на фирма се състои от 2 опции:

  1. Търсене по име на компания,
  2. Search by company code.
Списък на наличните държави: Гренландия (GRL), Грузия (GEO), Ирландия (IRL), Италианска република (ITA), Киргизката република (KGZ), Китайска народна република (CHN), Конфедерация Швейцария (CHE), Кралство Белгия (BEL), Кралство Дания (DNK), Кралство Испания (ESP), Кралство Нидерландия (NLD), Кралство Норвегия (NOR), Кралство Швеция (SWE), Монголия (MNG), Обединено кралство Великобритания и Северна Ирландия (GBR), Португалска република (PRT), Република Австрия (AUT), Република Азербайджан (AZE), Република Беларус (BLR), Република Естония (EST), Република Казахстан (KAZ), Република Кипър (CYP), Република Молдова (MDA), Република Полша (POL), Република Узбекистан (UZB), Република Финландия (FIN), Федерална република Германия (DEU), Френска република (FRA)
Важна информация:

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.

Регистърът на Норвегия не позволява търсене на заличени дружества по имена. Поради това не можем да предоставим SimpleSearch по имена в рамките на заличените дружества в Норвегия.

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

По-долу можете да намерите примера:


Функция SimpleSearch

Опция 2: Търсене по регистрационен код

Функция SimpleSearch

Как да поръчате кредитен отчет?


List of available countries for online credit reports: Киргизката република (KGZ), Кралство Белгия (BEL), Кралство Нидерландия (NLD), Кралство Швеция (SWE), Република Естония (EST), Република Казахстан (KAZ), Република Полша (POL), Република Финландия (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))

Функция SimpleSearch

To order an Online/Offline with identification report you need to receive "<search_result_id>".
To do so, please follow the link: Как да търсим компания?

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

Функция 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))

Функция 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))

Функция 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))

Функция 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.

За отчетите се използват следните състояния:

  • В процес на изпълнение - Доклад на етап производство
  • Canceled - Отменена поръчка
  • Finished - Докладът е готов
  • Updated - В готовия доклад е добавена информация
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - В нашата система е възникнала техническа грешка. Това означава, че сме информирани за тази грешка и ще я отстраним възможно най-скоро. Ще бъдете информирани кога ще можете да получите поръчката.

Ако статусът на изпълнение е Finished или Updated, тогава можете да получите поръчка.

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

Функция GetReport
Списък на наличните езици: bg (Български), cs (Чешки), da (Датски), de (Немски), el (Гръцки), en (Английски език), es (Испански), et (Естонски), fi (Финландски), fr (Френски), hu (Унгарски), id (Индонезийски), it (Италиански), ja (Японски), ko (Корейски), lt (Литовски), lv (Латвийски), nb (Норвежки Bokmål), nl (Холандски), pl (Полски), pt (Португалски), ro (Румънски), ru (Руски), sk (Словашки), sl (Словенски), sv (Шведски), tr (Турски), uk (Украински), zh (Китайски)

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

Функция 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))

Функция 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))

Функция 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))

Функция ChkStatus
For offline orders checking order status once every 30 minutes is acceptable frequency.

За отчетите се използват следните състояния:

  • В процес на изпълнение - Доклад на етап производство
  • Canceled - Отменена поръчка
  • Finished - Докладът е готов
  • Updated - В готовия доклад е добавена информация
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - В нашата система е възникнала техническа грешка. Това означава, че сме информирани за тази грешка и ще я отстраним възможно най-скоро. Ще бъдете информирани кога ще можете да получите поръчката.

Ако статусът на изпълнение е Finished или Updated, тогава можете да получите поръчка.

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

Функция GetReport
Списък на наличните езици: bg (Български), cs (Чешки), da (Датски), de (Немски), el (Гръцки), en (Английски език), es (Испански), et (Естонски), fi (Финландски), fr (Френски), hu (Унгарски), id (Индонезийски), it (Италиански), ja (Японски), ko (Корейски), lt (Литовски), lv (Латвийски), nb (Норвежки Bokmål), nl (Холандски), pl (Полски), pt (Португалски), ro (Румънски), ru (Руски), sk (Словашки), sl (Словенски), sv (Шведски), tr (Турски), uk (Украински), zh (Китайски)

Как да поръчате онлайн финансови отчети?


STEP 1: Find a company

Функция SimpleSearch

To order an online financial statements, you need to receive "<search_result_id>".
To do so, please follow the link: Как да търсим компания?

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: Търсене на налични финансови отчети

Функция ChkFinance

Тази функция е необходима само при поръчка на продукт: finances (Financial statements) с delivery_term = 'o'.

Списък на наличните държави: Република Естония (EST), Кралство Швеция (SWE)

STEP 3: Поръчайте финансови отчети

Функция 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)

Функция 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

Функция 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

Функция ChkStatus
  • - For online orders checking order status once every 5 seconds is acceptable frequency.

За отчетите се използват следните състояния:

  • В процес на изпълнение - Доклад на етап производство
  • Canceled - Отменена поръчка
  • Finished - Докладът е готов
  • Updated - В готовия доклад е добавена информация
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - В нашата система е възникнала техническа грешка. Това означава, че сме информирани за тази грешка и ще я отстраним възможно най-скоро. Ще бъдете информирани кога ще можете да получите поръчката.

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

Функция GetReport
Списък на наличните езици: bg (Български), cs (Чешки), da (Датски), de (Немски), el (Гръцки), en (Английски език), es (Испански), et (Естонски), fi (Финландски), fr (Френски), hu (Унгарски), id (Индонезийски), it (Италиански), ja (Японски), ko (Корейски), lt (Литовски), lv (Латвийски), nb (Норвежки Bokmål), nl (Холандски), pl (Полски), pt (Португалски), ro (Румънски), ru (Руски), sk (Словашки), sl (Словенски), sv (Шведски), tr (Турски), uk (Украински), zh (Китайски)
To see the examples of xml request/response, please follow the link: How to get finished order?

Как да изтеглите стандартни отчети (във формати, различни от 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.

Искането се състои от 3 части:

  1. Фиксирана част https://www.infoproff.com/en/orders/files/
  2. Вашия уникален хеш код, който предоставяме в отговор.
  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 - Оригинал (без замяна), 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

Как да изтеглите нестандартни продукти?


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.

Искането се състои от 3 части:

  1. Fixed part https://www.infoproff.com/en/orders/files/
  2. Вашия уникален хеш код, който предоставяме в отговор.
  3. И фиксирана част в края /download

Как да получите кредитно становище?


Функция CreditOpinionCalculator

Как да получите допълнителна информация?


Функция GetClassifiersFinancialStatements
Функция GetActivityClassificators
Функция GetDictionaryStandardPhrases
Функция GetAvailableProducts

delivery_term:

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

Възможни грешки


Тези грешки могат да възникнат при подаване на заявка към нашата уеб услуга..


Всички функции
  • Incorrect username/password or you have no permissions.
    Въвеждате грешни идентификационни данни или достъпът ви до API е блокиран.

Функция SimpleSearch
  1. You don't have permissions to search in this country.
    Списък на наличните държави: Гренландия (GRL), Грузия (GEO), Ирландия (IRL), Италианска република (ITA), Киргизката република (KGZ), Китайска народна република (CHN), Конфедерация Швейцария (CHE), Кралство Белгия (BEL), Кралство Дания (DNK), Кралство Испания (ESP), Кралство Нидерландия (NLD), Кралство Норвегия (NOR), Кралство Швеция (SWE), Монголия (MNG), Обединено кралство Великобритания и Северна Ирландия (GBR), Португалска република (PRT), Република Австрия (AUT), Република Азербайджан (AZE), Република Беларус (BLR), Република Естония (EST), Република Казахстан (KAZ), Република Кипър (CYP), Република Молдова (MDA), Република Полша (POL), Република Узбекистан (UZB), Република Финландия (FIN), Федерална република Германия (DEU), Френска република (FRA)
Функция Order
  1. This product is not available.
    Такъв продукт не може да бъде намерен и не е възможно да бъде поръчан.
  2. You can't order report on company with legal form: "legal_form"
    Тази грешка се отнася само за: Кралство Швеция (SWE)
    В Швеция не е възможно да поръчате онлайн доклад (delivery_term = "o") със следващите правни форми:
    • 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
    При поръчка на офлайн отчет (delivery_term = "n", "f" или "s") се изисква "Business Name" или "Reg Code".
  5. Reg Code is required when delivery term is Online
    При поръчка на онлайн отчет (delivery_term = "o") се изисква "Reg Code".

Функция GetReport
  1. This language is not supported.
    Списък на наличните езици за онлайн отчети: bg (Български), cs (Чешки), da (Датски), de (Немски), el (Гръцки), en (Английски език), es (Испански), et (Естонски), fi (Финландски), fr (Френски), hu (Унгарски), id (Индонезийски), it (Италиански), ja (Японски), ko (Корейски), lt (Литовски), lv (Латвийски), nb (Норвежки Bokmål), nl (Холандски), pl (Полски), pt (Португалски), ro (Румънски), ru (Руски), sk (Словашки), sl (Словенски), sv (Шведски), tr (Турски), uk (Украински), zh (Китайски)

Функции GetReport ChkStatus
  1. Incorrect order_id.
    Идентификаторът на поръчката не може да бъде намерен. Можете да получите ID на поръчката, когато използвате функцията Order.

Функция OrderCancellation
  1. Your order is already canceled.
    Вече нямате разрешение да отмените поръчката.

Функция OrderConfirmation
  1. You don't have permission to confirm the order anymore. Confirmation can be done within one hour after you recieved 'order_id'.

Промени в SOAP (версия 3) в сравнение със SOAP (версия 2)


Промени в SOAP (версия 3) в сравнение със SOAP (версия 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: Гренландия (GRL), Грузия (GEO), Ирландия (IRL), Италианска република (ITA), Киргизката република (KGZ), Китайска народна република (CHN), Конфедерация Швейцария (CHE), Кралство Белгия (BEL), Кралство Дания (DNK), Кралство Испания (ESP), Кралство Нидерландия (NLD), Кралство Норвегия (NOR), Кралство Швеция (SWE), Монголия (MNG), Обединено кралство Великобритания и Северна Ирландия (GBR), Португалска република (PRT), Република Австрия (AUT), Република Азербайджан (AZE), Република Беларус (BLR), Република Естония (EST), Република Казахстан (KAZ), Република Кипър (CYP), Република Молдова (MDA), Република Полша (POL), Република Узбекистан (UZB), Република Финландия (FIN), Федерална република Германия (DEU), Френска република (FRA)

- 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: Киргизката република (KGZ), Кралство Белгия (BEL), Кралство Нидерландия (NLD), Кралство Швеция (SWE), Република Естония (EST), Република Казахстан (KAZ), Република Полша (POL), Република Финландия (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 (Български), cs (Чешки), da (Датски), de (Немски), el (Гръцки), en (Английски език), es (Испански), et (Естонски), fi (Финландски), fr (Френски), hu (Унгарски), id (Индонезийски), it (Италиански), ja (Японски), ko (Корейски), lt (Литовски), lv (Латвийски), nb (Норвежки Bokmål), nl (Холандски), pl (Полски), pt (Португалски), ro (Румънски), ru (Руски), sk (Словашки), sl (Словенски), sv (Шведски), tr (Турски), uk (Украински), zh (Китайски)


Промени в SOAP (версия 3) в сравнение със SOAP (версия 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

Нови елементи:

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

Webhooks Settings


Преглед

Уебзадачата е начин, по който дадено приложение предоставя на други приложения информация в реално време. Нашата функция webhook реализира HTTP обратни повиквания, конфигурирани с URL адрес. Към този URL адрес се изпраща HTTP POST полезен товар във формат JSON, когато настъпи определено събитие. В контекста на нашия проект сме проектирали функцията webhook да задейства конкретни събития.

Настройка на Webhook

За да настроите уеб кука за приложението си, отидете на страницата с настройки на приложението и потърсете раздела "Настройки на уеб куки". И посочете следната информация:

  1. "Webhook URL" е URL адресът, на който сървърът ви ще получава POST заявки за Webhook.
  2. "Максимален брой опити за доставка" е настройката, която определя максималния брой опити за повторение, които трябва да бъдат направени за доставка на събитие с уеб примка, когато първоначалният опит за доставка е неуспешен.
  3. "Време за повторение на доставката " е настройка, която ви позволява да зададете времевия интервал между повторните опити, когато опитът за доставка на уеб примка е неуспешен.

След като предоставите тези данни, кликнете върху "Save".

Типове събития на Webhook

  1. Нов статус на поръчката

Полезен товар на Webhook

Когато възникне събитие, ще изпратим HTTP POST заявка към URL адреса на полезния товар с JSON тяло, съдържащо информация за събитието.

Ето един пример за полезен товар:
Пример за полезен товар за нов статус на поръчка
Възможни стойности на полето "new_status":
  • "Finished" - поръчката е завършена. Поръчката може да бъде взета;
  • "Updated" - актуализирана поръчка, добавени данни към завършена поръчка;
  • "Canceled" - поръчка е отменена по искане (или със съгласието) на клиента.;
  • "Rejected" - поръчката е отхвърлена. Обикновено защото е невъзможно да се идентифицира дадена компания.

Защита на вашите Webhooks

Важно е да се провери дали POST заявките, изпратени до URL адреса на полезния товар, са от нашето приложение. За да се подпомогне това, всяка заявка за webhook включва заглавие X-Signature.

Подпис Описание

За подписване използваме HMAC с алгоритъм SHA512.

Тайната е съвкупност от идентификатора на приложението и тайния ключ от настройките на уеб куките.

Възможно е да добавите свои собствени параметри за получаване към крайната точка, за да идентифицирате изпращача, ако е необходимо.

Отстраняване на неизправности

Сървърът трябва да отговори в рамките на 10 секунди и да върне HTTP код 2XX; в противен случай доставката на уеб приставката се счита за неуспешна. В случай на неуспех функцията ще се опита да изпрати отново заявката в съответствие с политиката за доставка.