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.
可用的国家名单: 中华人民共和国 (CHN), 丹麦王国 (DNK), 乌兹别克斯坦共和国 (UZB), 乔治亚州 (GEO), 吉尔吉斯共和国 (KGZ), 哈萨克斯坦共和国 (KAZ), 塞浦路斯共和国 (CYP), 大不列颠及北爱尔兰联合王国 (GBR), 奥地利共和国 (AUT), 德意志联邦共和国 (DEU), 意大利共和国 (ITA), 挪威王国 (NOR), 摩尔多瓦共和国 (MDA), 格陵兰岛 (GRL), 比利时王国 (BEL), 法兰西共和国 (FRA), 波兰共和国 (POL), 爱沙尼亚共和国 (EST), 瑞典王国 (SWE), 瑞士联邦 (CHE), 白俄罗斯共和国 (BLR), 芬兰共和国 (FIN), 荷兰王国 (NLD), 葡萄牙共和国 (PRT), 蒙古国 (MNG), 西班牙王国 (ESP), 辽宁省 (IRL), 阿塞拜疆共和国 (AZE)
重要信息:

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), 哈萨克斯坦共和国 (KAZ), 比利时王国 (BEL), 波兰共和国 (POL), 爱沙尼亚共和国 (EST), 瑞典王国 (SWE), 芬兰共和国 (FIN), 荷兰王国 (NLD)
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 - 我们的系统发生了一个技术错误。这意味着,我们已被告知这一错误,并将尽快修复它。您将被告知何时能够收到订单。

如果执行状态是FinishedUpdated ,那么你可以得到一个订单。

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 (挪威语), 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 - 我们的系统发生了一个技术错误。这意味着,我们已被告知这一错误,并将尽快修复它。您将被告知何时能够收到订单。

如果执行状态是FinishedUpdated ,那么你可以得到一个订单。

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 (挪威语), 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 (挪威语), 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.
    可用的国家名单: 中华人民共和国 (CHN), 丹麦王国 (DNK), 乌兹别克斯坦共和国 (UZB), 乔治亚州 (GEO), 吉尔吉斯共和国 (KGZ), 哈萨克斯坦共和国 (KAZ), 塞浦路斯共和国 (CYP), 大不列颠及北爱尔兰联合王国 (GBR), 奥地利共和国 (AUT), 德意志联邦共和国 (DEU), 意大利共和国 (ITA), 挪威王国 (NOR), 摩尔多瓦共和国 (MDA), 格陵兰岛 (GRL), 比利时王国 (BEL), 法兰西共和国 (FRA), 波兰共和国 (POL), 爱沙尼亚共和国 (EST), 瑞典王国 (SWE), 瑞士联邦 (CHE), 白俄罗斯共和国 (BLR), 芬兰共和国 (FIN), 荷兰王国 (NLD), 葡萄牙共和国 (PRT), 蒙古国 (MNG), 西班牙王国 (ESP), 辽宁省 (IRL), 阿塞拜疆共和国 (AZE)
功能 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" or "s")时,需要 "企业名称 "或 "注册代码"。
  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 (挪威语), nl (荷兰语), pl (波兰语), pt (葡萄牙语), ro (罗马尼亚语), ru (俄罗斯), sk (斯洛伐克语), sl (斯洛文尼亚语), sv (瑞典语), tr (土耳其语), uk (乌克兰), zh (中文)

职能 GetReport ChkStatus
  1. Incorrect order_id.
    找不到订单ID。当你使用Order 功能时,你会得到订单ID。

功能 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(版本 2)相比,SOAP(版本 3)的变化


与 SOAP(版本 2)相比,SOAP(版本 3)的变化 [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: 中华人民共和国 (CHN), 丹麦王国 (DNK), 乌兹别克斯坦共和国 (UZB), 乔治亚州 (GEO), 吉尔吉斯共和国 (KGZ), 哈萨克斯坦共和国 (KAZ), 塞浦路斯共和国 (CYP), 大不列颠及北爱尔兰联合王国 (GBR), 奥地利共和国 (AUT), 德意志联邦共和国 (DEU), 意大利共和国 (ITA), 挪威王国 (NOR), 摩尔多瓦共和国 (MDA), 格陵兰岛 (GRL), 比利时王国 (BEL), 法兰西共和国 (FRA), 波兰共和国 (POL), 爱沙尼亚共和国 (EST), 瑞典王国 (SWE), 瑞士联邦 (CHE), 白俄罗斯共和国 (BLR), 芬兰共和国 (FIN), 荷兰王国 (NLD), 葡萄牙共和国 (PRT), 蒙古国 (MNG), 西班牙王国 (ESP), 辽宁省 (IRL), 阿塞拜疆共和国 (AZE)

- 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), 哈萨克斯坦共和国 (KAZ), 比利时王国 (BEL), 波兰共和国 (POL), 爱沙尼亚共和国 (EST), 瑞典王国 (SWE), 芬兰共和国 (FIN), 荷兰王国 (NLD)

- 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 (挪威语), nl (荷兰语), pl (波兰语), pt (葡萄牙语), ro (罗马尼亚语), ru (俄罗斯), sk (斯洛伐克语), sl (斯洛文尼亚语), sv (瑞典语), tr (土耳其语), uk (乌克兰), zh (中文)


与 SOAP(版本 2)相比,SOAP(版本 3)的变化 [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


概述

网络钩子是应用程序向其他应用程序提供实时信息的一种方式。我们的网络钩子功能通过配置 URL 实现 HTTP 回调。每当指定事件发生时,就会以 JSON 格式向该 URL 发送 HTTP POST 有效载荷。在我们的项目中,我们设计了 Webhook 功能来触发特定事件。

设置 Webhook

要为应用程序设置网络钩子,请导航至应用程序设置页面并查找 "网络钩子设置 "部分。并提供以下信息:

  1. "Webhook URL "是服务器接收 Webhook POST 请求的 URL。
  2. "交付最大尝试次数 "是一种设置,用于定义当初始交付尝试失败时交付 webhook 事件的最大重试尝试次数。
  3. "交付重试超时 "是一项设置,可用于指定网络钩子交付尝试失败时重试的时间间隔。

提供这些详细信息后,点击 "保存"。

Webhook 事件类型

  1. 订单的新状态

Webhook 有效载荷

事件发生时,我们将向有效载荷 URL 发送 HTTP POST 请求,请求内容为包含事件信息的 JSON 主体。

下面是一个有效载荷示例:
订单新状态的有效载荷示例
"new_status" 字段的可能值:
  • "Finished" - 订单完成。可以提取订单;
  • "Updated" - 更新订单,为已完成的订单添加数据;
  • "Canceled" - 应客户要求(或同意)取消订单;
  • "Rejected" - 订单被拒绝。通常是因为无法确定一家公司.

确保网络钩子的安全

验证发送到有效负载 URL 的 POST 请求是否来自我们的应用程序非常重要。为此,每个 Webhook 请求都包含一个 X-Signature 头信息。

签名说明

我们使用 HMAC 和 SHA512 算法进行签名。

Secret是网络钩子设置中的应用程序 ID密钥的连接。

如有必要,还可以在端点中添加自己的获取参数,以识别发送方。

故障排除

服务器必须在 10 秒内做出响应,并返回 2XX HTTP 代码;否则,网络钩子交付将被视为失败。如果失败,该功能将尝试根据交付策略重新发送请求。