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

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: Бельгия (BEL), Казахстан (KAZ), Киргизия (KGZ), Нидерланды (NLD), Польша (POL), Финляндия (FIN), Швеция (SWE), Эстония (EST)
Field's length:
business_name varchar(512)
reg_code varchar(64)
vat_code varchar(64)
address varchar(512)
phone varchar(256)
email varchar(256)
additional_info varchar(512)
ref_code varchar(64)

Below you can find the example of how to order and download reports:

STEP 1: Find a company (Online/Offline Order (with search_result_id))

Функция 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.
    Список доступных стран: Австрия (AUT), Азербайджан (AZE), Беларусь (BLR), Бельгия (BEL), Германия (DEU), Гренландия (GRL), Грузия (GEO), Дания (DNK), Ирландия (IRL), Испания (ESP), Италия (ITA), Казахстан (KAZ), Кипр (CYP), Киргизия (KGZ), Китай (CHN), Молдова (MDA), Монголия (MNG), Нидерланды (NLD), Норвегия (NOR), Польша (POL), Португалия (PRT), Соединенное Королевство (GBR), Узбекистан (UZB), Финляндия (FIN), Франция (FRA), Швейцария (CHE), Швеция (SWE), Эстония (EST)
Функция 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") необходимо указать название компании или регистрационный код.
  5. Reg Code is required when delivery term is Online
    При заказе онлайн-отчета (delivery_term = "o") регистрационный код обязателен.

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

- 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: Бельгия (BEL), Казахстан (KAZ), Киргизия (KGZ), Нидерланды (NLD), Польша (POL), Финляндия (FIN), Швеция (SWE), Эстония (EST)

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

3) Function: GetReport

- Changes in of available languages: bg (Болгарский), 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-запросы веб-хуков.
  2. "Delivery max attempts" - это параметр, определяющий максимальное количество повторных попыток, которые должны быть предприняты для доставки события webhook при неудачной первой попытке доставки.
  3. "Таймаут повторной доставки" - это параметр, который позволяет указать интервал времени между повторными попытками, когда попытка доставки веб-крючка не удалась.

После ввода этих данных нажмите "Сохранить".

Типы событий Webhook

  1. Новый статус заказа

Полезная нагрузка вебхука

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

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

Обеспечение безопасности веб-крючков

Важно убедиться, что POST-запросы, отправленные на URL-адрес полезной нагрузки, исходят от нашего приложения. Чтобы помочь в этом, каждый запрос вебхука включает заголовок X-Signature.

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

Для подписания мы используем HMAC с алгоритмом SHA512.

Secret - это комбинация App ID и Secret Key из настроек вебхуков.

При необходимости можно добавить в конечную точку свои собственные параметры get params для идентификации отправителя.

Устранение неполадок

Сервер должен ответить в течение 10 секунд и вернуть HTTP-код 2XX; в противном случае доставка webhook считается неудачной. В случае неудачи функция попытается повторно отправить запрос в соответствии с политикой доставки.