Infoproff API ドキュメント - v3


はじめに


Webサービスの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.
利用可能な国の一覧: アイルランド (IRL), アゼルバイジャン共和国 (AZE), イタリア共和国 (ITA), ウズベキスタン共和国 (UZB), エストニア共和国 (EST), オランダ王国 (NLD), オーストリア共和国 (AUT), カザフスタン共和国 (KAZ), キプロス共和国 (CYP), キルギス共和国 (KGZ), グリーンランド (GRL), グルジア (GEO), グレートブリテン及び北アイルランド連合王国 (GBR), スイス連邦 (CHE), スウェーデン王国 (SWE), スペイン王国 (ESP), デンマーク王国 (DNK), ドイツ連邦共和国 (DEU), ノルウェー王国 (NOR), フィンランド共和国 (FIN), フランス共和国 (FRA), ベラルーシ共和国 (BLR), ベルギー王国 (BEL), ポルトガル共和国 (PRT), ポーランド共和国 (POL), モルドバ共和国 (MDA), モンゴル (MNG), 中華人民共和国 (CHN)
重要なお知らせ:

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: エストニア共和国 (EST), オランダ王国 (NLD), カザフスタン共和国 (KAZ), キルギス共和国 (KGZ), スウェーデン王国 (SWE), フィンランド共和国 (FIN), ベルギー王国 (BEL), ポーランド共和国 (POL)
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 (ノルウェー語ブークモール), 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 (ノルウェー語ブークモール), 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.
    利用可能な国の一覧: アイルランド (IRL), アゼルバイジャン共和国 (AZE), イタリア共和国 (ITA), ウズベキスタン共和国 (UZB), エストニア共和国 (EST), オランダ王国 (NLD), オーストリア共和国 (AUT), カザフスタン共和国 (KAZ), キプロス共和国 (CYP), キルギス共和国 (KGZ), グリーンランド (GRL), グルジア (GEO), グレートブリテン及び北アイルランド連合王国 (GBR), スイス連邦 (CHE), スウェーデン王国 (SWE), スペイン王国 (ESP), デンマーク王国 (DNK), ドイツ連邦共和国 (DEU), ノルウェー王国 (NOR), フィンランド共和国 (FIN), フランス共和国 (FRA), ベラルーシ共和国 (BLR), ベルギー王国 (BEL), ポルトガル共和国 (PRT), ポーランド共和国 (POL), モルドバ共和国 (MDA), モンゴル (MNG), 中華人民共和国 (CHN)
機能 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")を注文する場合、"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.
    Onlineレポートで使用できる言語の一覧: 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: アイルランド (IRL), アゼルバイジャン共和国 (AZE), イタリア共和国 (ITA), ウズベキスタン共和国 (UZB), エストニア共和国 (EST), オランダ王国 (NLD), オーストリア共和国 (AUT), カザフスタン共和国 (KAZ), キプロス共和国 (CYP), キルギス共和国 (KGZ), グリーンランド (GRL), グルジア (GEO), グレートブリテン及び北アイルランド連合王国 (GBR), スイス連邦 (CHE), スウェーデン王国 (SWE), スペイン王国 (ESP), デンマーク王国 (DNK), ドイツ連邦共和国 (DEU), ノルウェー王国 (NOR), フィンランド共和国 (FIN), フランス共和国 (FRA), ベラルーシ共和国 (BLR), ベルギー王国 (BEL), ポルトガル共和国 (PRT), ポーランド共和国 (POL), モルドバ共和国 (MDA), モンゴル (MNG), 中華人民共和国 (CHN)

- 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: エストニア共和国 (EST), オランダ王国 (NLD), カザフスタン共和国 (KAZ), キルギス共和国 (KGZ), スウェーデン王国 (SWE), フィンランド共和国 (FIN), ベルギー王国 (BEL), ポーランド共和国 (POL)

- 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コールバックを実装しています。指定されたイベントが発生するたびに、HTTP POSTペイロードがJSON形式でこのURLに送信されます。私たちのプロジェクトのコンテキストでは、特定のイベントをトリガーするようにwebhook機能を設計しました。

ウェブフックの設定

アプリケーションにWebhookを設定するには、アプリケーションの設定ページに移動し、「Webhooks Settings」セクションを探します。そして以下の情報を入力してください:

  1. Webhook URL "は、サーバーがWebhookのPOSTリクエストを受け取るURLです。
  2. 「配信最大試行回数 "は、最初の配信試行が失敗した場合に、Webhook イベントを配信するための最大再試行回数を定義する設定です。
  3. 「配信再試行タイムアウト "は、ウェブフックの配信試行が失敗した場合の再試行の時間間隔を指定できる設定です。

これらの情報を入力したら、「保存」をクリックします。

Webhookイベントの種類

  1. 新しい注文状況

ウェブフックペイロード

イベントが発生すると、そのイベントに関する情報を含むJSONボディを持つHTTP POSTリクエストをペイロードURLに送信する。

これがペイロードの例だ:
新しい注文ステータスのペイロード例
"new_status" フィールドの取り得る値:
  • "Finished" - 注文が完了しました。注文の受け取り;
  • "Updated" - 注文が更新され、完了した注文にデータが追加された。;
  • "Canceled" - 顧客の要求(または同意)により注文がキャンセルされた場合。;
  • "Rejected" - 注文が拒否される。通常、会社を特定することは不可能だからだ。.

Webhooksの保護

ペイロード URL に送信された POST リクエストがアプリケーションからのものであることを確認することが重要です。これを支援するために、すべてのWebhookリクエストはX-Signatureヘッダを含んでいます。

シグネチャー

署名にはSHA512アルゴリズムによるHMACを使用する。

SecretはApp IDとWebhooks設定のSecret Keyを連結したもの。

必要であれば、送信者を特定するために独自のget paramsをエンドポイントに追加することも可能である。

トラブルシューティング

サーバーは10秒以内に応答し、2XX HTTPコードを返さなければなりません。そうでなければ、ウェブフックの配信は失敗したとみなされます。そうでない場合、Webhook の配信は失敗したとみなされます。失敗した場合、この機能は配信ポリシーに従ってリクエストの再送を試みます。