Infoproff API Dokümantasyonu - v3


Başlarken


Web hizmeti wsdl ve şemaları burada bulunur:

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

Web service functions:

  • SimpleSearch - Farklı ülkelerdeki şirket bilgilerini arayın.
  • ChkFinance - Mevcut mali tabloları arayın.
  • Order - Bir order_id oluşturur ve kopyaları döndürür. Kopyalar sonraki parametrelere göre seçilir: country, product, reg_code.
  • OrderCancellation - Bir sipariş talebi gönderdiyseniz ve order_id adresini aldıysanız, bu siparişi iptal etme fırsatınız vardır (eğer üretime geçmediyse).
  • OrderConfirmation - order_id adresini aldıktan sonra siparişinizi 1 saat içinde onaylamanız gerekecektir. Eğer siparişinizi 1 saat içinde onaylamazsanız, siparişiniz otomatik olarak iptal edilecektir.
  • ChkStatus - Sipariş durumunu kontrol edin.
  • GetReport - Bitmiş raporları alın.

  • GetClassifiersFinancialStatements - Tüm finansal belgeleri tüm öğelerle birlikte alın: row_number, row_formated_description, row_lang_key ve row_order.
  • GetLegalForms - Mevcut tüm ülkeler için tüm yasal formları alın.
  • GetActivityClassificators - Belirli bir faaliyet sınıflandırıcısı için tüm kodları ve açıklamaları alın.
  • GetDictionaryStandardPhrases - Anahtarlar ve dil ile tüm standart ifadeleri alın.
  • GetAvailableProducts - Mevcut ürünlerin bir listesini alın.

  • CreditOpinionCalculator - Kredi Görüşü Hesaplayıcı, bir şirket hakkında kredi görüşü atamaya yardımcı olur.

API çeşitli hizmetler sağlar:

  1. Aşağıdaki ülkeler için çevrimiçi kredi raporları: Finlandiya Cumhuriyeti (FIN), İsveç Krallığı (SWE), Belçika Krallığı (BEL), Hollanda Krallığı (NLD), Estonya Cumhuriyeti (EST)
  2. Aşağıdaki ülkeler için çevrimdışı raporlar: Tüm ülkeler
  3. Kredi görüş hesaplayıcı

Bir şirket nasıl aranır?


Şirket araması 2 seçenekten oluşur:

  1. Şirket adına göre arama,
  2. Search by company code.
Mevcut ülkelerin listesi: Avusturya Cumhuriyeti (AUT), Azerbaycan Cumhuriyeti (AZE), Belarus Cumhuriyeti (BLR), Belçika Krallığı (BEL), Büyük Britanya ve Kuzey İrlanda Birleşik Krallığı (GBR), Danimarka Krallığı (DNK), Estonya Cumhuriyeti (EST), Federal Almanya Cumhuriyeti (DEU), Finlandiya Cumhuriyeti (FIN), Fransız Cumhuriyeti (FRA), Grönland (GRL), Gürcistan (GEO), Hollanda Krallığı (NLD), Kazakistan Cumhuriyeti (KAZ), Kıbrıs Cumhuriyeti (CYP), Kırgız Cumhuriyeti (KGZ), Moldova Cumhuriyeti (MDA), Moğolistan (MNG), Norveç Krallığı (NOR), Polonya Cumhuriyeti (POL), Portekiz Cumhuriyeti (PRT), Çin Halk Cumhuriyeti (CHN), Özbekistan Cumhuriyeti (UZB), İrlanda (IRL), İspanya Krallığı (ESP), İsveç Krallığı (SWE), İsviçre Konfederasyonu (CHE), İtalyan Cumhuriyeti (ITA)
Önemli bilgiler:

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.

Norveç sicili, silinmiş şirketlerin isimlerine göre aranmasına izin vermemektedir. Bu nedenle, Norveç'te silinen şirketler içinde isimlere göre bir SimpleSearch sağlayamıyoruz.

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

Aşağıda örneği bulabilirsiniz:


Fonksiyon SimpleSearch

Seçenek 2: Kayıt koduna göre arama

Fonksiyon SimpleSearch

Kredi raporu nasıl sipariş edilir?


List of available countries for online credit reports: Belçika Krallığı (BEL), Estonya Cumhuriyeti (EST), Finlandiya Cumhuriyeti (FIN), Hollanda Krallığı (NLD), Kazakistan Cumhuriyeti (KAZ), Kırgız Cumhuriyeti (KGZ), Polonya Cumhuriyeti (POL), İsveç Krallığı (SWE)
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))

Fonksiyon SimpleSearch

To order an Online/Offline with identification report you need to receive "<search_result_id>".
To do so, please follow the link: Bir şirket nasıl aranır?

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

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

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

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

Fonksiyon 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.

Raporlar için aşağıdaki durumlar kullanılır:

  • Devam ediyor - Üretim aşamasında rapor
  • Canceled - İptal edilen sipariş
  • Finished - Rapor hazır
  • Updated - Tamamlanan rapora bilgi eklendi
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Sistemimizde teknik bir hata meydana geldi. Bu, bu hata hakkında bilgilendirildiğimiz ve en kısa sürede düzelteceğimiz anlamına gelir. Siparişinizi ne zaman teslim alabileceğiniz konusunda bilgilendirileceksiniz.

Yürütme durumu Finished veya Updated ise, bir emir alabilirsiniz.

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

Fonksiyon GetReport
Mevcut dillerin listesi: bg (Bulgarca), cs (Çek Cumhuriyeti), da (Danimarka), de (Alman), el (Yunan), en (İngilizce), es (İspanyolca), et (Estonca), fi (Fince), fr (Fransızca), hu (Macarca), id (Endonezce), it (İtalyan), ja (Japonca), ko (Korece), lt (Litvanyalı), lv (Letonca), nb (Norveççe Bokmål), nl (Hollandaca), pl (Lehçe), pt (Portekizce), ro (Romence), ru (Rusça), sk (Slovakça), sl (Slovence), sv (İsveç), tr (Türkçe), uk (Ukrayna), zh (Çince)

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

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

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

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

Fonksiyon ChkStatus
For offline orders checking order status once every 30 minutes is acceptable frequency.

Raporlar için aşağıdaki durumlar kullanılır:

  • Devam ediyor - Üretim aşamasında rapor
  • Canceled - İptal edilen sipariş
  • Finished - Rapor hazır
  • Updated - Tamamlanan rapora bilgi eklendi
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Sistemimizde teknik bir hata meydana geldi. Bu, bu hata hakkında bilgilendirildiğimiz ve en kısa sürede düzelteceğimiz anlamına gelir. Siparişinizi ne zaman teslim alabileceğiniz konusunda bilgilendirileceksiniz.

Yürütme durumu Finished veya Updated ise, bir emir alabilirsiniz.

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

Fonksiyon GetReport
Mevcut dillerin listesi: bg (Bulgarca), cs (Çek Cumhuriyeti), da (Danimarka), de (Alman), el (Yunan), en (İngilizce), es (İspanyolca), et (Estonca), fi (Fince), fr (Fransızca), hu (Macarca), id (Endonezce), it (İtalyan), ja (Japonca), ko (Korece), lt (Litvanyalı), lv (Letonca), nb (Norveççe Bokmål), nl (Hollandaca), pl (Lehçe), pt (Portekizce), ro (Romence), ru (Rusça), sk (Slovakça), sl (Slovence), sv (İsveç), tr (Türkçe), uk (Ukrayna), zh (Çince)

Online mali tablolar nasıl sipariş edilir?


STEP 1: Find a company

Fonksiyon SimpleSearch

To order an online financial statements, you need to receive "<search_result_id>".
To do so, please follow the link: Bir şirket nasıl aranır?

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: Mevcut mali tabloları arayın

Fonksiyon ChkFinance

Bu işlev yalnızca bir ürün sipariş ederken gereklidir: finances (Financial statements) ile delivery_term = 'o'.

Mevcut ülkelerin listesi: Estonya Cumhuriyeti (EST), İsveç Krallığı (SWE)

STEP 3: Mali tablolar sipariş edin

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

Fonksiyon 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

Fonksiyon 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

Fonksiyon ChkStatus
  • - For online orders checking order status once every 5 seconds is acceptable frequency.

Raporlar için aşağıdaki durumlar kullanılır:

  • Devam ediyor - Üretim aşamasında rapor
  • Canceled - İptal edilen sipariş
  • Finished - Rapor hazır
  • Updated - Tamamlanan rapora bilgi eklendi
  • Rejected - Order is rejected (Insufficient funds, incorrect order details or other reason).
  • Technical Error - Sistemimizde teknik bir hata meydana geldi. Bu, bu hata hakkında bilgilendirildiğimiz ve en kısa sürede düzelteceğimiz anlamına gelir. Siparişinizi ne zaman teslim alabileceğiniz konusunda bilgilendirileceksiniz.

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

Fonksiyon GetReport
Mevcut dillerin listesi: bg (Bulgarca), cs (Çek Cumhuriyeti), da (Danimarka), de (Alman), el (Yunan), en (İngilizce), es (İspanyolca), et (Estonca), fi (Fince), fr (Fransızca), hu (Macarca), id (Endonezce), it (İtalyan), ja (Japonca), ko (Korece), lt (Litvanyalı), lv (Letonca), nb (Norveççe Bokmål), nl (Hollandaca), pl (Lehçe), pt (Portekizce), ro (Romence), ru (Rusça), sk (Slovakça), sl (Slovence), sv (İsveç), tr (Türkçe), uk (Ukrayna), zh (Çince)
To see the examples of xml request/response, please follow the link: How to get finished order?

Standart raporlar (XML dışındaki formatlarda) nasıl indirilir?


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.

Talep 3 bölümden oluşmaktadır:

  1. Sabit parça https://www.infoproff.com/en/orders/files/
  2. Yanıt olarak sağladığımız benzersiz hash'iniz
  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 - Orijinal (değişim yok), 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

Standart olmayan ürünler nasıl indirilir?


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.

Talep 3 bölümden oluşmaktadır:

  1. Fixed part https://www.infoproff.com/en/orders/files/
  2. Yanıt olarak sağladığımız benzersiz hash'iniz
  3. Ve sondaki sabit kısım /download

Kredi görüşü nasıl alınır?


Fonksiyon CreditOpinionCalculator

Ek bilgi nasıl alınır?


Fonksiyon GetClassifiersFinancialStatements
Fonksiyon GetActivityClassificators
Fonksiyon GetDictionaryStandardPhrases
Fonksiyon GetAvailableProducts

delivery_term:

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

Olası hatalar


Web servisimize talepte bulunurken bu hatalar oluşabilir.


Tüm fonksiyonlar
  • Incorrect username/password or you have no permissions.
    Yanlış kimlik bilgileri giriyorsunuz veya API erişiminiz engellendi.

Fonksiyon SimpleSearch
  1. You don't have permissions to search in this country.
    Mevcut ülkelerin listesi: Avusturya Cumhuriyeti (AUT), Azerbaycan Cumhuriyeti (AZE), Belarus Cumhuriyeti (BLR), Belçika Krallığı (BEL), Büyük Britanya ve Kuzey İrlanda Birleşik Krallığı (GBR), Danimarka Krallığı (DNK), Estonya Cumhuriyeti (EST), Federal Almanya Cumhuriyeti (DEU), Finlandiya Cumhuriyeti (FIN), Fransız Cumhuriyeti (FRA), Grönland (GRL), Gürcistan (GEO), Hollanda Krallığı (NLD), Kazakistan Cumhuriyeti (KAZ), Kıbrıs Cumhuriyeti (CYP), Kırgız Cumhuriyeti (KGZ), Moldova Cumhuriyeti (MDA), Moğolistan (MNG), Norveç Krallığı (NOR), Polonya Cumhuriyeti (POL), Portekiz Cumhuriyeti (PRT), Çin Halk Cumhuriyeti (CHN), Özbekistan Cumhuriyeti (UZB), İrlanda (IRL), İspanya Krallığı (ESP), İsveç Krallığı (SWE), İsviçre Konfederasyonu (CHE), İtalyan Cumhuriyeti (ITA)
Fonksiyon Order
  1. This product is not available.
    Böyle bir ürün bulunamıyor ve sipariş vermek mümkün değil.
  2. You can't order report on company with legal form: "legal_form"
    Bu hata yalnızca aşağıdakiler için geçerlidir: İsveç Krallığı (SWE)
    İsveç'te bir sonraki yasal formlarla birlikte çevrimiçi rapor (delivery_term = "o") sipariş etmek mümkün değildir:
    • 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
    Çevrimdışı rapor sipariş ederken (delivery_term = "n", "f" veya "s") "İşletme Adı" veya "Reg Kodu" gereklidir.
  5. Reg Code is required when delivery term is Online
    Online rapor siparişi verirken (delivery_term = "o") "Reg Code" gereklidir.

Fonksiyon GetReport
  1. This language is not supported.
    Çevrimiçi raporlar için mevcut dillerin listesi: bg (Bulgarca), cs (Çek Cumhuriyeti), da (Danimarka), de (Alman), el (Yunan), en (İngilizce), es (İspanyolca), et (Estonca), fi (Fince), fr (Fransızca), hu (Macarca), id (Endonezce), it (İtalyan), ja (Japonca), ko (Korece), lt (Litvanyalı), lv (Letonca), nb (Norveççe Bokmål), nl (Hollandaca), pl (Lehçe), pt (Portekizce), ro (Romence), ru (Rusça), sk (Slovakça), sl (Slovence), sv (İsveç), tr (Türkçe), uk (Ukrayna), zh (Çince)

Fonksiyonlar GetReport ChkStatus
  1. Incorrect order_id.
    Sipariş kimliği bulunamıyor. Order işlevini kullandığınızda sipariş kimliğini alırsınız.

Fonksiyon OrderCancellation
  1. Your order is already canceled.
    Artık siparişi iptal etme izniniz yok.

Fonksiyon 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 (Sürüm 2) ile karşılaştırıldığında SOAP (Sürüm 3) değişiklikleri


SOAP (Sürüm 2) ile karşılaştırıldığında SOAP (Sürüm 3) değişiklikleri [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: Avusturya Cumhuriyeti (AUT), Azerbaycan Cumhuriyeti (AZE), Belarus Cumhuriyeti (BLR), Belçika Krallığı (BEL), Büyük Britanya ve Kuzey İrlanda Birleşik Krallığı (GBR), Danimarka Krallığı (DNK), Estonya Cumhuriyeti (EST), Federal Almanya Cumhuriyeti (DEU), Finlandiya Cumhuriyeti (FIN), Fransız Cumhuriyeti (FRA), Grönland (GRL), Gürcistan (GEO), Hollanda Krallığı (NLD), Kazakistan Cumhuriyeti (KAZ), Kıbrıs Cumhuriyeti (CYP), Kırgız Cumhuriyeti (KGZ), Moldova Cumhuriyeti (MDA), Moğolistan (MNG), Norveç Krallığı (NOR), Polonya Cumhuriyeti (POL), Portekiz Cumhuriyeti (PRT), Çin Halk Cumhuriyeti (CHN), Özbekistan Cumhuriyeti (UZB), İrlanda (IRL), İspanya Krallığı (ESP), İsveç Krallığı (SWE), İsviçre Konfederasyonu (CHE), İtalyan Cumhuriyeti (ITA)

- 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çika Krallığı (BEL), Estonya Cumhuriyeti (EST), Finlandiya Cumhuriyeti (FIN), Hollanda Krallığı (NLD), Kazakistan Cumhuriyeti (KAZ), Kırgız Cumhuriyeti (KGZ), Polonya Cumhuriyeti (POL), İsveç Krallığı (SWE)

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

3) Function: GetReport

- Changes in of available languages: bg (Bulgarca), cs (Çek Cumhuriyeti), da (Danimarka), de (Alman), el (Yunan), en (İngilizce), es (İspanyolca), et (Estonca), fi (Fince), fr (Fransızca), hu (Macarca), id (Endonezce), it (İtalyan), ja (Japonca), ko (Korece), lt (Litvanyalı), lv (Letonca), nb (Norveççe Bokmål), nl (Hollandaca), pl (Lehçe), pt (Portekizce), ro (Romence), ru (Rusça), sk (Slovakça), sl (Slovence), sv (İsveç), tr (Türkçe), uk (Ukrayna), zh (Çince)


SOAP (Sürüm 2) ile karşılaştırıldığında SOAP (Sürüm 3) değişiklikleri [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

Yeni unsurlar:

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

Webhooks Settings


Genel Bakış

Web kancası, bir uygulamanın diğer uygulamalara gerçek zamanlı bilgi sağlamasının bir yoludur. Webhook özelliğimiz, bir URL ile yapılandırılmış HTTP geri aramalarını uygular. Belirli bir olay gerçekleştiğinde bu URL'ye JSON formatında bir HTTP POST yükü gönderilir. Projemiz bağlamında, webhook işlevini belirli olayları tetiklemek için tasarladık.

Web kancası kurma

Uygulamanız için bir web kancası ayarlamak için, uygulama ayarları sayfasına gidin ve 'Web Kancaları Ayarları' bölümünü arayın. Ve aşağıdaki bilgileri sağlayın:

  1. "Webhook URL'si" sunucunuzun webhook POST isteklerini alacağı URL'dir.
  2. "Maksimum teslim denemeleri", ilk teslim denemesi başarısız olduğunda bir web kancası olayını teslim etmek için yapılması gereken maksimum yeniden deneme sayısını tanımlayan ayardır.
  3. "Teslim yeniden deneme zaman aşımı", bir web kancası teslim denemesi başarısız olduğunda yeniden denemeler arasındaki zaman aralığını belirlemenizi sağlayan bir ayardır.

Bu bilgileri girdikten sonra 'Kaydet'e tıklayın.

Webhook Olay Türleri

  1. Siparişin yeni durumu

Webhook Yükü

Bir olay gerçekleştiğinde, olay hakkında bilgi içeren bir JSON gövdesi ile yük URL'sine bir HTTP POST isteği göndereceğiz.

İşte örnek bir yük:
Siparişin yeni durumuna ilişkin ödeme yükü örneği
"new_status" alanının olası değerleri:
  • "Finished" - bir sipariş tamamlanmıştır. Bir sipariş teslim alınabilir;
  • "Updated" - bir sipariş güncellendi, tamamlanmış bir siparişe veri eklendi;
  • "Canceled" - müşterinin talebi (veya onayı) üzerine bir siparişin iptal edilmesi;
  • "Rejected" - bir sipariş reddedilir. Genellikle bir şirketi tanımlamak imkansız olduğu için.

Web kancalarınızın güvenliğini sağlama

Yük URL'sine gönderilen POST isteklerinin uygulamamızdan geldiğini doğrulamak önemlidir. Buna yardımcı olmak için, her web kancası isteği bir X-İmza başlığı içerir.

İmza Açıklaması

İmzalama için SHA512 algoritması ile HMAC kullanıyoruz.

Gizli, webhooks ayarlarından Uygulama Kimliği ve Gizli Anahtarın bir araya getirilmesidir.

Gerekirse göndereni tanımlamak için uç noktaya kendi get params'ınızı eklemek mümkündür.

Sorun Giderme

Bir sunucu 10 saniye içinde yanıt vermeli ve 2XX HTTP kodu döndürmelidir; aksi takdirde web kancası teslimatı başarısız kabul edilir. Başarısızlık durumunda, özellik teslim politikasına göre isteği yeniden göndermeyi deneyecektir.