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

認証

Flex Forward APIの全エンドポイントは、AuthorizationヘッダーにBearerトークンを使用した認証が必要です。

APIトークンの取得

APIアクセストークンは、オンボーディングまたはアカウント承認時にFlex Forwardチームから発行されます。開発環境または本番環境のアクセスをリクエストするには、[email protected] までご連絡ください。
APIトークンは機密情報です。クライアントサイドのコード、公開リポジトリ、安全でない通信経路で共有しないでください。

アクセスの仕組み

Flex Forwardはマネージドオンボーディングモデルを採用しています。APIアクセスは、お客様の配送ルートと配送業者の要件に合わせてアカウントが正しく設定されるよう、Flex Forwardチームがプロビジョニングします。
1

Flex Forwardチームに連絡

ユースケース、予想配送量、必要な配送ルートを記載して [email protected] にメールをお送りください。
2

開発環境アクセスの受領

チームが開発環境の認証情報をプロビジョニングし、配送業者のサンドボックスサービスでのテスト用にシッパーアカウントを設定します。
3

インテグレーションのテスト

開発環境を使用してインテグレーションを構築・検証してください。ラベル作成、文書取得、追跡を確認してください。
4

本番環境アクセスのリクエスト

テスト成功後、本番環境の認証情報をリクエストしてください。チームが準備状況を確認し、本番環境アクセスをプロビジョニングします。

shipperAccountIdについて

shipperAccountId は、設定済みのシッパーアカウントを識別するUUIDです(例:a1b2c3d4-e5f6-7890-abcd-ef1234567890)。オンボーディング時にFlex Forwardチームがプロビジョニングし、配送業者と配送ルートの設定にリンクされます。単一のAPIアカウントで、異なる配送業者設定に対応する複数のシッパーアカウントIDを持つことが可能です。

認証済みリクエストの送信

全リクエストのAuthorizationヘッダーにトークンを含めてください:
curl -X POST https://api.flexforward.com/labels \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "idempotencyKey": "ord-20250301-abc123",
    "courier": "yunexpress",
    "service": {
      "shipperAccountId": "your-account-id",
      "productCode": "YEXP01"
    },
    "shipment": { ... }
  }'

エラーレスポンス

トークンが欠落または無効の場合、APIは 401 Unauthorized レスポンスを返します:
{
  "error": "Unauthorized"
}
トークンは有効だが、リクエストされたリソースへのアクセス権がない場合、APIは 403 Forbidden レスポンスを返します:
{
  "error": "Forbidden"
}

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

  • トークンを定期的にローテーションする
  • 開発環境と本番環境で個別のトークンを使用する
  • トークンは環境変数またはシークレットマネージャーに保存する — ハードコードしない