コンテンツにスキップ

APIキーの取得

PASTA公開APIはAPIキー認証を使用します。外部システムからパスを発行・管理したり、独自の検証フローを構築したりする際に必要です。

  1. 管理画面にログインし、「APIキー」画面を開きます(管理者のみ)。
  2. 「APIキーを作成」をクリックし、用途に応じたスコープを選択します:
    • issueスコープ:パスの発行・管理(サーバー間連携向け)
    • validateスコープ:検証のみ(キオスク向け、より制限された権限)
  3. 「作成」をクリックし、表示された生のAPIキーを安全な場所に保存します。

:::danger 生のAPIキーは一度しか確認できません APIキーは作成時に一度だけ表示されます。モーダルを閉じると再確認できません。必ずコピーして保管してください。 :::

すべてのAPIリクエストに X-Api-Key ヘッダーを付与します:

X-Api-Key: pasta_xxxxxxxxxxxxxxxxxxxx
環境ベースURL
本番https://api.passes.me
開発https://api-dev.passes.me
  • APIキーはバージョン管理システム(Gitなど)にコミットしないでください
  • 本番用と開発用のAPIキーを使い分けてください
  • 不要になったAPIキーはすぐに失効させてください
  • APIキーが漏洩した場合は、管理画面から即時失効させ、新しいキーを発行してください