APIカタログ
APIドキュメント
APIの紹介
貨物保険APIは、貨物保険をオンラインで取得するためのシームレスな統合を提供します。この API を使用すると、ユーザーは荷物を効率的に管理して保険をかけ、輸送中の潜在的な損失に対する安心感と経済的保護を確保できます。 API は、以下に示すステージング用と実稼働用の 2 つのベース URL への POST リクエストを介してアクセスされ、ヘッダーapi_keyおよびapi_sec。これらは管理者によって提供されます。この合理化されたアプローチにより、現代の物流業務のニーズに合わせた迅速かつ安全な保険処理が可能になります。
ベース URL: https://cargoinsureonline.com/wp-json/api/v2
API ヘッダー:
api_key: API_KEY
api_sec: API_SEC
すべての保険オプションを取得する
Get All Insurance オプション API は、新しい保険を購入する際に選択する必要がある国、グループ タイプ、リスク タイプ、輸送タイプ、通貨などのすべてのオプションを提供します。
エンドポイント: /get-cargo-insurance-options
APIメソッド: GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/get-cargo-insurance-options' \
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC'
すべての国を取得
すべての国を取得オプション API は、国際物流および保険プロセスに不可欠な国のリストを提供します。
エンドポイント: / get-cargo-insurance-options ?type=countries
APIメソッド: GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/get-cargo-insurance-options?type=countries' \
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC '
すべてのグループタイプを取得
すべてのグループ タイプの取得 API は、電子商取引、アートワーク、一般貨物など、貨物が分類されるすべてのグループ タイプのリストを提供します。
エンドポイント: / get-cargo-insurance-options ?type=group_types
APIメソッド: GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/ get-cargo-insurance-options ?type=group_types' \
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC'
すべてのリスクタイプを取得する
すべてのリスク タイプを取得 API を使用すると、貨物が受ける可能性のあるすべてのリスクのリストが得られます。
エンドポイント: /g et-cargo-insurance-options ?type=risk_types
APIメソッド: GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/ get-cargo-insurance-options ?type=risk_types' \
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC'
すべてのトランスポート タイプを取得する
Get All Transport Types API は、航空、海上、道路、宅配便など、貨物が通過できるすべての輸送方法のリストを提供します。
エンドポイント: / get-cargo-insurance-options ?type=transport_types
APIメソッド: GET
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC'
すべての通貨を取得する
すべての通貨を取得 API は、国際貿易や金融取引に不可欠な世界通貨の詳細なリストをユーザーに提供します。
エンドポイント: / get-cargo-insurance-options ?type=currency
APIメソッド: GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/ get-cargo-insurance-options ?type=currency' \
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC'
すべての通信事業者を取得
Get All Carriers API は、Chronopost、DHL、FedEx、UPS など、ほとんどの顧客が使用しているすべての運送業者のリストを提供します。
エンドポイント: / get-cargo-insurance-options ?type=carriers
APIメソッド: GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/ get-cargo-insurance-options ?type=currency' \
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC'
貨物保険に加入する
Buy Insurance API を使用すると、ユーザーは貨物に対する貨物保険を効率的に購入できます。エンドポイント/buy-cargo-insurance、ユーザーは詳細な出荷情報と顧客情報を含む POST リクエストを送信して、必要な保険を確保することができます。この API は貨物保険の取得プロセスを合理化し、タイムリーかつ正確に貨物を保護します。
エンドポイント: /buy-cargo-insurance
貨物保険料率を取得する
この API を使用すると、保険を購入せずに保険料率を取得できます。 buy-cargo-insurance と同じすべてのデータを受け入れ、最低価格の保険の詳細のみを返します。
エンドポイント: /get-cargo-insurance-rates
任意のユーザーの請求情報を取得する
すべてのクレーム情報を取得する API は、すべての詳細、クレーム値、ドキュメントなどを返します。これは、API 呼び出しで使用される API キーと API シークレット ヘッダーに基づきます。
エンドポイント: /get-claims-by-user-id
APIメソッド: GET
応答例:
[{
"id": "1",
"user_id": "101",
"policy_number": "A123",
"company_name": "Example Insurance Co.", "
contact_name": "John Doe",
"email": "johndoe@example.com"、
"電話": "1234567890"、
"claim_value": "500.00"、
「損失の日付」: 「2024-01-01」、
「説明」: 「請求の説明のサンプル」、
「文書」: 「a:2:{i:0;s:94:\」https://example.com/ files/sample-image1.png\”;i:1;s:88:\”https://example.com/files/sample-document1.pdf\”;}”,
"status": "審査中"、
"remarks": "検証中"、
"claim_date": "2024-01-02 10:00:00"
}]
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/get-claims-by-user-id' \
–header 'api_key: API_KEY ' \
–header 'api_sec: API_SEC'