このページは英語から翻訳されています。英語版が正式な情報源です。翻訳内容に不一致がある場合は、英語版を参照してください。
Flex Forward API
Flex Forwardは、配送ラベルの作成、エアウェイビル文書の取得、配送追跡を一つのAPIで提供します。統一されたリクエスト形式、正規化された追跡データ、冪等性を備えた一つのインテグレーションで複数の配送業者に対応します。主なワークフロー
ラベル作成
冪等性のあるリクエストで配送業者を通じて配送ラベルを作成します。
ラベル文書取得
作成したラベルのエアウェイビルPDFまたはPNGを取得します。
配送追跡
すべての配送業者で統一されたフォーマットでリアルタイムの追跡情報を取得します。
3ステップで始める
1
APIアクセスを取得
Return Helper User Portal(Settings → Signing Key and API Token)でAPIキーとAPIトークンを取得するか、[email protected] までお問い合わせください。
2
最初のラベルを作成
配送情報を含む
POST /labels リクエストを送信します。APIからラベルIDとトラッキング番号が返されます。3
文書の取得と追跡
ラベルIDを使用してエアウェイビル文書(
GET /labels/{id})を取得し、配送状況を追跡(GET /tracking/{id})します。クイックスタートガイドに従う
認証から最初のラベル作成までのステップバイステップのガイド。
インテグレーションフロー
最初のリクエスト例
201 Created
本番環境の対応範囲
Flex Forwardは現在、YunExpressによる本番環境での配送をサポートしており、グローバルな越境EC配送に対応しています。
追加の配送業者は、配送ルートの要件とアカウントのオンボーディングに基づいて有効化されます。配送業者の利用可能状況については、Flex Forwardチームまでお問い合わせください。
環境
すべてのAPIリクエストはHTTPSで行う必要があります。開発環境は配送業者のサンドボックスサービスに接続されており、安全にテストを行えます。
環境の詳細
認証情報の分離、環境の動作、運用上の注意事項。
プラットフォームの信頼性
認証
APIキーとトークンヘッダー認証、および認証情報管理のベストプラクティス。
エラーハンドリング
HTTPステータスコード、エラーレスポンス形式、トラブルシューティングガイド。
冪等性とリトライ
重複ラベル作成を防止し、リクエストを安全にリトライする方法。
バージョニング
APIの変更と後方互換性の管理方法。
OpenAPI 仕様
OpenAPI仕様をダウンロード
コード生成、クライアントSDK、APIツーリング用のOpenAPI 3.1仕様をダウンロードできます。
サポート
オンボーディング、インテグレーションサポート、または配送業者の利用可能状況に関するお問い合わせは、Flex Forwardチームまでご連絡ください:[email protected]サポートとFAQ
テクニカルサポート、オンボーディングガイド、よくある質問。