express-delivery-outlets-query-v2
宅配便営業所検索
宅配便営業所検索APIサービスを提供し、開発者が宅配便営業所の関連情報を迅速に検索し、業務システムへ簡単に統合できるようにします。
利用料金
5 コイン/回
クイックスタート
統一レスポンス形式のまま、バックエンドから直接呼び出せます。
https://openapi.toolkk.com/v1/express-delivery-outlets-query-v2cURL 例
curl --request POST \
--url 'https://openapi.toolkk.com/v1/express-delivery-outlets-query-v2' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: YOUR_API_KEY' \
--data '{\n "city": "北京",\n "expressName": "顺丰"\n}'Python 例
import os
import requests
url = "https://openapi.toolkk.com/v1/express-delivery-outlets-query-v2"
payload = {
"city": "北京",
"expressName": "顺丰"
}
headers = {
"Content-Type": "application/json",
"X-API-Key": os.getenv("TOOLKK_API_KEY", "YOUR_API_KEY"),
}
response = requests.request("POST", url, headers=headers, json=payload, timeout=30)
response.raise_for_status()
print(response.json())Go 例
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
endpoint := "https://openapi.toolkk.com/v1/express-delivery-outlets-query-v2"
payload := []byte("{\n \"city\": \"北京\",\n \"expressName\": \"顺丰\"\n}")
req, err := http.NewRequest("POST", endpoint, bytes.NewBuffer(payload))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}Java 例
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ToolkkExample {
public static void main(String[] args) throws Exception {
String payload = "{\n \"city\": \"北京\",\n \"expressName\": \"顺丰\"\n}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://openapi.toolkk.com/v1/express-delivery-outlets-query-v2"))
.method("POST", HttpRequest.BodyPublishers.ofString(payload))
.header("Content-Type", "application/json")
.header("X-API-Key", "YOUR_API_KEY")
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}PHP 例
<?php
$endpoint = 'https://openapi.toolkk.com/v1/express-delivery-outlets-query-v2';
$payload = "{\n \"city\": \"北京\",\n \"expressName\": \"顺丰\"\n}";
$ch = curl_init($endpoint);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'X-API-Key: YOUR_API_KEY',
],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response;レスポンス例
{
"code": "SUCCESS",
"message": "success",
"data": {
"total": 1,
"list": [
{
"name": "顺丰速运(北京朝阳门点)",
"address": "北京市朝阳区朝阳门外大街",
"phone": "95338"
}
]
}
}例はレスポンスの構造を示しています。実際の結果はAPIの応答によって異なります。
- 認証方式
- リクエストヘッダーに X-API-Key を設定
- レート制限
- 毎分 600 回
- タイムアウト
- 10000 ms
サーバー側から呼び出す際は、X-API-Key ヘッダーに API Key を設定します。
HTTP ステータスと業務フィールドの両方で成功判定するのがおすすめです。
高頻度利用ではレート制限と再試行戦略を併用してください。
リクエスト項目
サーバーからリクエストを送信し、X-API-Keyヘッダーにキーを設定してください。
リクエスト項目
以下の項目はサンプル JSON から自動抽出した参考情報です。
| パス | 型 | 必須 | 説明 | サンプル値 |
|---|---|---|---|---|
| city | string | 未指定 | 未指定 | 北京 |
| expressName | string | 未指定 | 未指定 | 顺丰 |
リクエスト例
{
"city": "北京",
"expressName": "顺丰"
}- 認証方式
- リクエストヘッダーに X-API-Key を設定
- レート制限
- 毎分 600 回
- タイムアウト
- 10000 ms
レスポンス項目
例はレスポンスの構造を示しています。実際の結果はAPIの応答によって異なります。
レスポンス項目
以下の項目はサンプル JSON から自動抽出した参考情報です。
| パス | 型 | 必須 | 説明 | サンプル値 |
|---|---|---|---|---|
| code | string | 未指定 | 未指定 | SUCCESS |
| message | string | 未指定 | 未指定 | success |
| data | object | 未指定 | 未指定 | {...} |
| data.total | number | 未指定 | 未指定 | 1 |
| data.list | array | 未指定 | 未指定 | [{"name":"顺丰速运(北京朝阳门点)","address":"北京市朝阳区朝阳门外大街","phone":"95338"}] |
| data.list[] | object | 未指定 | 未指定 | {...} |
レスポンス例
{
"code": "SUCCESS",
"message": "success",
"data": {
"total": 1,
"list": [
{
"name": "顺丰速运(北京朝阳门点)",
"address": "北京市朝阳区朝阳门外大街",
"phone": "95338"
}
]
}
}APIの概要
機能、利用シーン、制約、よくある質問。
宅配便営業所検索APIの概要
宅配便営業所検索APIは、開発者がシステム内で宅配便営業所の検索処理を迅速に行えるよう支援します。構造化された結果を返すため、配送追跡、注文照会、顧客通知などのシナリオに最適です。
適用シナリオ
- 宅配便営業所検索機能を、社内システム、SaaSプラットフォーム、自動化ワークフロー、または運用管理画面に統合できます。
- 安定したAPI呼び出し、標準化されたレスポンス、およびオーケストレーション可能なインターフェース機能を必要とするビジネスシナリオに適しています。
- システム全体の安定性を向上させるため、リクエストのレート制限(頻度制御)、エラー時の再試行(リトライ)、および結果のキャッシュ戦略と組み合わせて使用することをお勧めします。
導入時のアドバイス
- 導入前に、リクエストパラメータの形式、認証方法、およびエラーコードの処理ロジックを確認してください。
- 高頻度で検索を行うシナリオでは、ログ追跡、タイムアウト制御、およびべき等性(Idempotency)の処理を適切に実装することを推奨します。
- 検索結果をリスク管理や自動意思決定に使用する場合は、APIのレスポンスのみに依存するのではなく、ビジネスルールと組み合わせた二次判定を行うことをお勧めします。