認証

APIリクエストの認証方法

認証

WhereParcel APIはAPIキーを使用してリクエストを認証します。ダッシュボードでAPIキーを表示および管理できます。

APIキーの取得

  1. WhereParcelアカウントにサインイン
  2. ダッシュボード → APIキーに移動
  3. 新しいAPIキーを生成をクリック
  4. APIキーとシークレットキーを安全に保存

:::warning ⚠️ 重要: シークレットキーを安全に保存してください。再度表示できません！ :::

リクエストヘッダー

すべてのAPIリクエストには次のヘッダーが含まれている必要があります：

ヘッダー説明
AuthorizationBearerトークン形式: Bearer {apiKey}:{secretKey}
Content-Typeapplication/jsonである必要があります

cURLの例

curl -X POST https://api.whereparcel.com/v2/track \
  -H "Authorization: Bearer YOUR_API_KEY:YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "trackingItems": [
      {
        "carrier": "jp.post",
        "trackingNumber": "1234567890123"
      }
    ]
  }'

環境変数の使用

バージョン管理にコミットされないように、APIキーを環境変数に保存してください：

# .env ファイル
WHEREPARCEL_API_KEY=your_api_key_here
WHEREPARCEL_SECRET_KEY=your_secret_key_here

:::tip 💡 ヒント: .envファイルを.gitignoreに追加して、誤って機密情報をコミットするのを防ぎます。 :::

セキュリティのベストプラクティス

  • APIキーを公開しないでください
  • 環境変数にキーを保存してください
  • 開発環境と本番環境で異なるキーを使用してください
  • 定期的にキーをローテーションしてください
  • 侵害されたキーはすぐに取り消してください