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

Сменить версию V4

Начало работы

wsdl веб-сервиса и схемы находятся здесь:

https://wsdfn.infoproff.com/v4/

Postman Collection (API v4) — Ready for Use:

https://www.postman.com/infoproff/infoproff-webservices/documentation/9kweer5/soap-api-v4

Postman provides a convenient way to test our API without the need to write any code. It can also automatically generate example HTTP requests for most common programming languages.

The requests generated by Postman are basic HTTP calls compatible with our SOAP API. However, for production-grade integration, we recommend using fully featured SOAP clients available in most programming languages. These clients can work directly with WSDL and XSD, automatically handling schemas, data types, and message structures.

Using a dedicated SOAP client ensures a more reliable and robust integration, reducing the likelihood of errors when constructing and parsing SOAP messages.

Authentification details

The primary authentication method is HTTP Basic Auth. Using the Authorization header with encoded credentials is the preferred and recommended approach.

The username corresponds to the App ID, and the password is the associated Secret Key. These values are generated in the API Tokens section of the user dashboard and are not related to the credentials used for logging into the portal.

The authentication_block mechanism, used in previous API versions, is still supported for backward compatibility but is considered deprecated and should not be used in new integrations.

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), Казахстан (KAZ), Польша (POL), Киргизия (KGZ), Китай (CHN), Монголия (MNG)
  2. Оффлайн кредитные отчеты для следующих стран: Все страны
  3. Калькулятор кредитного мнения

Как искать компанию?

Поиск компании состоит из 2 вариантов:

  1. Поиск по названию компании,
  2. Search by company code.
Список доступных стран: Австралия (AUS), Австрия (AUT), Азербайджан (AZE), Албания (ALB), Алжир (DZA), Ангола (AGO), Аргентина (ARG), Беларусь (BLR), Бельгия (BEL), Бенин (BEN), Болгария (BGR), Боливия (BOL), Босния и Герцеговина (BIH), Ботсвана (BWA), Бразилия (BRA), Венгрия (HUN), Венесуэла (VEN), Гайана (GUY), Гамбия (GMB), Гваделупа (GLP), Гвинея (GIN), Германия (DEU), Гонконг (HKG), Гренландия (GRL), Греция (GRC), Грузия (GEO), Дания (DNK), Джерси (JEY), Замбия (ZMB), Зимбабве (ZWE), Израиль (ISR), Ирландия (IRL), Исландия (ISL), Испания (ESP), Италия (ITA), Казахстан (KAZ), Канада (CAN), Кения (KEN), Кипр (CYP), Киргизия (KGZ), Китай (CHN), Конго (COG), Косово (XXK), Кот-д'Ивуар (CIV), Латвия (LVA), Литва (LTU), Лихтенштейн (LIE), Люксембург (LUX), Маврикий (MUS), Мадагаскар (MDG), Майотта (MYT), Мальдивы (MDV), Мальта (MLT), Марокко (MAR), Мартиника (MTQ), Молдова (MDA), Монако (MCO), Монголия (MNG), Намибия (NAM), Нигерия (NGA), Нидерланды (NLD), Новая Зеландия (NZL), Норвегия (NOR), Остров Мэн (IMN), Парагвай (PRY), Перу (PER), Польша (POL), Португалия (PRT), Реюньон (REU), Россия (RUS), Руанда (RWA), Румыния (ROU), Самоа (WSM), Сан-Марино (SMR), Сейшелы (SYC), Сен-Мартен (MAF), Сербия (SRB), Сингапур (SGP), Словакия (SVK), Словения (SVN), Соединенное Королевство (GBR), Таджикистан (TJK), Таиланд (THA), Тайвань (TWN), Танзания, Объединенная Республика (TZA), Того (TGO), Узбекистан (UZB), Уругвай (URY), Филиппины (PHL), Финляндия (FIN), Франция (FRA), Французская Гвиана (GUF), Хорватия (HRV), Чешская Республика (CZE), Чили (CHL), Швейцария (CHE), Швеция (SWE), Шри-Ланка (LKA), Эквадор (ECU), Эстония (EST), Эфиопия (ETH), Южная Африка (ZAF), Япония (JPN)

The search for other countries is performed only in the database of archived reports. If you do not find the desired company, enter the company details manually.

Важная информация:

search_result_id can be acquired here for orders with delivery_term = "o" or delivery_term = "a".

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

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

Функция UnifiedSearch

Как заказать кредитный отчет?

List of available countries for online credit reports: Австрия (AUT), Азербайджан (AZE), Бельгия (BEL), Болгария (BGR), Венгрия (HUN), Германия (DEU), Греция (GRC), Дания (DNK), Ирландия (IRL), Испания (ESP), Италия (ITA), Казахстан (KAZ), Киргизия (KGZ), Китай (CHN), Латвия (LVA), Люксембург (LUX), Мальта (MLT), Молдова (MDA), Монголия (MNG), Нидерланды (NLD), Норвегия (NOR), Польша (POL), Португалия (PRT), Россия (RUS), Словакия (SVK), Словения (SVN), Соединенное Королевство (GBR), Финляндия (FIN), Франция (FRA), Хорватия (HRV), Чешская Республика (CZE), Швейцария (CHE), Швеция (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.

Для отчетов используются следующие статусы:

  • Выполняется - Отчет на стадии производства
  • Identification pending - Подготовка отчета в режиме ожидания. Требуются дополнительные данные от клиента.
  • 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
Список доступных языков: ar (Arabic), bg (Болгарский), cs (Чешский), da (Датский), de (Немецкий), el (Греческий), en (Английский), es (Испанский), et (Эстонский), fi (Финский), fr (Французский), he (Hebrew), hu (Венгерский), id (Индонезийский), it (Итальянский), ja (Японский), ko (Корейский), lt (Литовский), lv (Латышский), nb (Норвежский (Bokmål)), nl (Голландский), pl (Польский), pt (Португальский), ro (Румынский), ru (Русский), sk (Словацкий), sl (Словенский), sr (Српски), sv (Шведский), th (Thai), tr (Турецкий), uk (Украинский), vi (Vietnamese), 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.

Для отчетов используются следующие статусы:

  • Выполняется - Отчет на стадии производства
  • Identification pending - Подготовка отчета в режиме ожидания. Требуются дополнительные данные от клиента.
  • 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
Список доступных языков: ar (Arabic), bg (Болгарский), cs (Чешский), da (Датский), de (Немецкий), el (Греческий), en (Английский), es (Испанский), et (Эстонский), fi (Финский), fr (Французский), he (Hebrew), hu (Венгерский), id (Индонезийский), it (Итальянский), ja (Японский), ko (Корейский), lt (Литовский), lv (Латышский), nb (Норвежский (Bokmål)), nl (Голландский), pl (Польский), pt (Португальский), ro (Румынский), ru (Русский), sk (Словацкий), sl (Словенский), sr (Српски), sv (Шведский), th (Thai), tr (Турецкий), uk (Украинский), vi (Vietnamese), zh (Китайский)

Как заказать архивный кредитный отчет?

Purchase of an archived report is available for all countries.

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

STEP 1: Find a company

Функция SimpleSearch

To order an archived report you need to receive "<search_result_id>" which has an "<archived_reports>" section that contains a product you need.
To do so, please follow the link: Как искать компанию?

Example companies with archived reports:

  • Country: EST, Reg. Code: 12309116
  • Country: EST, Reg. Code: 12854256
  • Country: EST, Reg. Code: 12830238
  • Country: USA, Company name: Apple

STEP 2: Order a report

Функция Order

STEP 3: Order cancellation (Optional)

Just like the online/offline reports.

STEP 4: Order confirmation

Just like the online/offline reports.

STEP 5: Check order status

Just like the online/offline reports.

For archived orders checking order status once every 5 seconds is acceptable frequency.

STEP 6: Get report

Just like the online/offline reports.

Как заказать финансовую отчетность онлайн?

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.

Для отчетов используются следующие статусы:

  • Выполняется - Отчет на стадии производства
  • Identification pending - Подготовка отчета в режиме ожидания. Требуются дополнительные данные от клиента.
  • 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
Список доступных языков: ar (Arabic), bg (Болгарский), cs (Чешский), da (Датский), de (Немецкий), el (Греческий), en (Английский), es (Испанский), et (Эстонский), fi (Финский), fr (Французский), he (Hebrew), hu (Венгерский), id (Индонезийский), it (Итальянский), ja (Японский), ko (Корейский), lt (Литовский), lv (Латышский), nb (Норвежский (Bokmål)), nl (Голландский), pl (Польский), pt (Португальский), ro (Румынский), ru (Русский), sk (Словацкий), sl (Словенский), sr (Српски), sv (Шведский), th (Thai), tr (Турецкий), uk (Украинский), vi (Vietnamese), 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, ar, bg, cs, da, de, el, fi, fr, he, hu, id, it, ja, ko, lt, nl, nb, pl, pt, ro, sk, sl, es, sr, sv, th, tr, uk, vi, 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.
    Список доступных стран: Австралия (AUS), Австрия (AUT), Азербайджан (AZE), Албания (ALB), Алжир (DZA), Ангола (AGO), Аргентина (ARG), Беларусь (BLR), Бельгия (BEL), Бенин (BEN), Болгария (BGR), Боливия (BOL), Босния и Герцеговина (BIH), Ботсвана (BWA), Бразилия (BRA), Венгрия (HUN), Венесуэла (VEN), Гайана (GUY), Гамбия (GMB), Гваделупа (GLP), Гвинея (GIN), Германия (DEU), Гонконг (HKG), Гренландия (GRL), Греция (GRC), Грузия (GEO), Дания (DNK), Джерси (JEY), Замбия (ZMB), Зимбабве (ZWE), Израиль (ISR), Ирландия (IRL), Исландия (ISL), Испания (ESP), Италия (ITA), Казахстан (KAZ), Канада (CAN), Кения (KEN), Кипр (CYP), Киргизия (KGZ), Китай (CHN), Конго (COG), Косово (XXK), Кот-д'Ивуар (CIV), Латвия (LVA), Литва (LTU), Лихтенштейн (LIE), Люксембург (LUX), Маврикий (MUS), Мадагаскар (MDG), Майотта (MYT), Мальдивы (MDV), Мальта (MLT), Марокко (MAR), Мартиника (MTQ), Молдова (MDA), Монако (MCO), Монголия (MNG), Намибия (NAM), Нигерия (NGA), Нидерланды (NLD), Новая Зеландия (NZL), Норвегия (NOR), Остров Мэн (IMN), Парагвай (PRY), Перу (PER), Польша (POL), Португалия (PRT), Реюньон (REU), Россия (RUS), Руанда (RWA), Румыния (ROU), Самоа (WSM), Сан-Марино (SMR), Сейшелы (SYC), Сен-Мартен (MAF), Сербия (SRB), Сингапур (SGP), Словакия (SVK), Словения (SVN), Соединенное Королевство (GBR), Таджикистан (TJK), Таиланд (THA), Тайвань (TWN), Танзания, Объединенная Республика (TZA), Того (TGO), Узбекистан (UZB), Уругвай (URY), Филиппины (PHL), Финляндия (FIN), Франция (FRA), Французская Гвиана (GUF), Хорватия (HRV), Чешская Республика (CZE), Чили (CHL), Швейцария (CHE), Швеция (SWE), Шри-Ланка (LKA), Эквадор (ECU), Эстония (EST), Эфиопия (ETH), Южная Африка (ZAF), Япония (JPN)
Функция 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.
    Список доступных языков для Онлайн-отчетов: ar (Arabic), bg (Болгарский), cs (Чешский), da (Датский), de (Немецкий), el (Греческий), en (Английский), es (Испанский), et (Эстонский), fi (Финский), fr (Французский), he (Hebrew), hu (Венгерский), id (Индонезийский), it (Итальянский), ja (Японский), ko (Корейский), lt (Литовский), lv (Латышский), nb (Норвежский (Bokmål)), nl (Голландский), pl (Польский), pt (Португальский), ro (Румынский), ru (Русский), sk (Словацкий), sl (Словенский), sr (Српски), sv (Шведский), th (Thai), tr (Турецкий), uk (Украинский), vi (Vietnamese), 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 (версия 4) по сравнению с SOAP (версия 3)

Новые разделы

  • country_economic_overview — включают следующие подразделы: data_transparency_index, country_development_indicators, economic_forecast.
  • paid_taxes — информация об уплаченных налогах.
  • tenders — информация о тендерах.
  • sanctions — добавлено в раздел « negative_information ».

Обновления существующих разделов

В разделы « beneficiaries », « shareholders », « managers » и « employees_data » добавлен следующий элемент:
  • source_type — тип источника данных (например, official, mass_media, company_admin и т. д.).
В разделе « relations_of_persons » добавлен новый элемент:
  • match_type
Раздел « capital » был переструктурирован:
  • Элемент « capital_amount » был переименован в « issued_capital ».
  • Добавлены следующие новые элементы:
    • number_of_shares
    • share_value
    • authorized_capital
В разделе « employees_data »:
  • Новый элемент « group_figure » указывает, включают ли данные агрегированные показатели на уровне группы (true).
  • Элемент source_type указывает тип источника данных.
  • Элемент « is_estimated » теперь включается только в том случае, если его значение равно « true ».
Новый раздел « assets_data » — объединяет ранее существовавшие разделы:
  • real_estate_data (ранее называвшийся « property_data »), « vehicles » и « machinery_and_equipment » (ранее называвшийся « assets »).
  • Планируемые дополнения: « patents » и « biological_assets ».
В разделе « vehicles » добавлено новое поле:
  • value
В разделе « litigations » добавлены следующие элементы:
  • content, instance, process, authority
В financial_statement/positions и summary/latest_turnovers добавлен новый элемент:
  • value_origin — описывает происхождение значения; например, значение « estimated » — это значение оценивается и рассчитывается на основе доступных данных с использованием логики или искусственного интеллекта.
В разделе branches_data добавлены следующие поля:
  • registration_number
  • director_name

Примечание: на этапе стабилизации могут быть внесены незначительные улучшения и корректировки.

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" - заказ отклоняется. Обычно из-за невозможности идентифицировать компанию.
  • "Identification pending" - нам необходимо получить дополнительную информацию от клиента, прежде чем мы сможем подготовить заказ..

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

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

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

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

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

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

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

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