このページは英語から翻訳されています。英語版が正式な情報源です。翻訳内容に不一致がある場合は、英語版を参照してください。

認証

Flex Forward APIの全エンドポイントは、2つのヘッダー（x-rr-apikey と x-rr-apitoken）による認証が必要です。

API認証情報の取得

API認証情報はReturn Helper User Portalで管理します。Return Helperのユーザーアカウントが必要です。Flex Forward Portalと同じログイン情報を使用します。 Return Helper API認証ガイドの手順に従い、Settings → Signing Key and API Tokenで認証情報を確認または生成してください。次の両方の値が必要です：

認証情報	ヘッダー
APIキー	`x-rr-apikey: YOUR_API_KEY`
APIトークン	`x-rr-apitoken: YOUR_API_TOKEN`

同じAPIキーとAPIトークンで、Flex Forward APIとReturn Helper User APIの両方を認証できます：

API	認証方法
Flex Forward API	`x-rr-apikey` および `x-rr-apitoken`
Return Helper User API	`x-rr-apikey` および `x-rr-apitoken`

認証が必要なFlex Forwardリクエストには、必ず両方のヘッダーを含めてください。いずれかが欠けている場合、または Authorization: Bearer トークンのみを使用する場合は、ドキュメントに記載された顧客向け認証方法ではありません。

APIトークンとAPIキーは機密情報です。クライアントサイドのコード、公開リポジトリ、安全でない通信経路で共有しないでください。

アクセスの仕組み

User Portalにサインイン

Flex Forward Portalと同じアカウントでReturn Helper User Portalにログインしてください。

認証情報を取得

Settings → Signing Key and API Tokenに移動するか、Return Helper APIドキュメントのAuthenticationの手順に従ってください。APIキーとAPIトークンの両方をコピーします。

Flex Forwardリクエストを認証

すべてのリクエストに x-rr-apikey と x-rr-apitoken の両方を含めてください（下記参照）。同じ組み合わせでReturn Helper User APIも認証できます。

サポートが必要な場合

アカウントアクセス、ポータルのログイン問題、その他のお問い合わせは [email protected] までご連絡ください。

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

すべてのリクエストに両方のヘッダーを含めてください：

curl -X POST https://api.flexforward.com/labels \
  -H "x-rr-apikey: YOUR_API_KEY" \
  -H "x-rr-apitoken: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "idempotencyKey": "unique-key-per-request",
      "courier": "yunexpress",
      "service": {
        "productCode": "HKMUZXR"
      },
      "label": {
        "format": "PDF"
      },
      "units": {
        "weight": "KG",
        "dimension": "CM"
      },
      "order": {
        "customerOrderNumber": "N-2026-05-27-TEST-03",
        "orderNumbers": {
          "platformOrderNumber": "platform-order-number",
          "referenceNumbers": [
            "ref-number-1",
            "ref-number-2"
          ]
        }
      },
      "shipment": {
        "shipTo": {
          "contact": {
            "firstName": "Alex",
            "lastName": "Smith",
            "phone": "8554377467",
            "email": "[email protected]"
          },
          "address": {
            "streetLines": [
              "18 Distribution Blvd"
            ],
            "city": "Edison",
            "state": "New jersey",
            "postalCode": "08817",
            "countryCode": "US"
          }
        },
        "shipFrom": {
          "contact": {
            "firstName": "John",
            "lastName": "Doe",
            "phone": "886900676877",
            "email": "[email protected]"
          },
          "address": {
            "streetLines": [
              "Habucho"
            ],
            "city": "Kishiwada-Shi",
            "state": "Osaka",
            "postalCode": "596-0825",
            "countryCode": "JP"
          }
        },
        "parcels": [
          {
            "weight": 0.5,
            "dimension": {
              "length": 30,
              "width": 20,
              "height": 10
            },
            "items": [
              {
                "descriptionEn": "Muji Ink pen",
                "descriptionLocal": "文具",
                "quantity": 1,
                "unitPrice": {
                  "amount": 29.99,
                  "currency": "USD"
                },
                "unitWeight": 0.5
              }
            ]
          }
        ]
      },
      "serviceOptions": [
        {
          "code": "V1",
          "value": "云途预缴"
        }
      ],
      "courierOptions": {
        "yunexpress": {
          "sourceCode": "YT",
          "sensitiveType": "D"
        }
      }
  }'

エラーレスポンス

いずれかの認証情報が欠落または無効の場合、APIは 401 Unauthorized レスポンスを返します：

{
  "error": "Unauthorized"
}

認証情報は有効だが、リクエストされたリソースへのアクセス権がない場合、APIは 403 Forbidden レスポンスを返します：

{
  "error": "Forbidden"
}

認証情報のベストプラクティス

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

はじめに

ガイド

ユースケースガイド

プラットフォーム

認証

認証

API認証情報の取得

アクセスの仕組み

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

エラーレスポンス

認証情報のベストプラクティス

​認証

​API認証情報の取得

​アクセスの仕組み

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

​エラーレスポンス

​認証情報のベストプラクティス

認証

API認証情報の取得

アクセスの仕組み

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

エラーレスポンス

認証情報のベストプラクティス