メインコンテンツへスキップ

環境

Flex Forward APIは、本番運用と開発テストのために2つの環境を提供しています。

利用可能な環境

環境ベースURL配送業者接続
本番https://api.flexforward.com本番配送業者サービス
開発https://sandbox.flexforward.com配送業者サンドボックスサービス
すべてのリクエストはHTTPSを使用する必要があります。HTTPでのリクエストは拒否されます。

開発環境

開発環境は配送業者のサンドボックスサービス(例:YunExpressサンドボックス)に接続されます。以下の用途にご利用ください:
  • 実際の配送を作成せずにインテグレーションをテスト
  • リクエスト形式とレスポンス処理の検証
  • エラーハンドリングとリトライロジックの開発
サンドボックスの配送業者サービスは、シミュレートされた追跡データとラベル文書を返す場合があります。レスポンスのタイミングや利用可能な追跡ステータスが本番と異なる場合があります。

サンドボックステストデータ

開発環境は、予測可能な追跡レスポンスを生成するテスト値をサポートしています。これらを使用して、インテグレーションがさまざまな配送結果を正しく処理することを確認してください:
配送先郵便番号シミュレートされる追跡結果
90001Delivered — 配送が正常に完了
90002Exception — 配達例外が発生
90003InTransit — 配送が無期限に輸送中のまま
90004Cancelled — 配送がキャンセル
テスト値とシミュレートされたレスポンスは変更される場合があります。最新のサンドボックステストデータについては、Flex Forwardチームにお問い合わせください。

認証情報の分離

各環境には個別のAPIトークンをご使用ください。本番の認証情報を開発で使用したり、その逆を行ったりしないでください。
本番トークンは本番の配送業者サービスにアクセスします。リクエストを送信する前に、必ず対象の環境を確認してください。

トークンのベストプラクティス

  • トークンを環境変数またはシークレットマネージャーに保存する
  • ソースコードにトークンをハードコードしたり、バージョン管理にコミットしたりしない
  • 開発中の本番への誤ったリクエストを防ぐため、環境ごとに個別のトークンを使用する
  • 定期的にトークンをローテーションする
トークンの使用方法とエラーレスポンスの詳細については認証をご覧ください。

レート制限

レート制限は現在適用されていません。目安として、アカウントごとに 1秒あたり10リクエスト 以下に抑えてください。レート制限ヘッダー(X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-Reset)は現在レスポンスに含まれていません。 将来レート制限が導入される場合は、事前通知とともに変更履歴を通じてお知らせします。高スループットのインテグレーションに関するキャパシティプランニングについては、Flex Forwardチームに [email protected] までご連絡ください。

本番移行チェックリスト

開発環境から本番環境に切り替える前に:
  • 開発トークンが発行されテスト済み
  • 本番トークンがFlex Forwardチームにより承認済み
  • 本番の配送業者用にシッパーアカウントが設定済み
  • 開発環境でラベル作成が正常にテスト済み
  • ラベル文書の取得がテスト済み
  • 追跡の取得がテスト済み
  • 冪等性の動作を検証済み(重複キーで同じ結果が返る)
  • すべてのステータスコードに対するエラーハンドリングが実装済み
  • 必要な配送業者と配送ルートの設定が確認済み

HTTPS要件

すべてのAPIエンドポイントはTLS 1.2以上のHTTPSが必要です。HTTPで送信されたリクエストは接続エラーになります。