認証

Basee Payroll Engine の計算・マスタ照会APIは、すべて X-API-Key ヘッダーによる認証を必要とします。

リクエストヘッダー

すべてのリクエストに、発行済みのAPIキーを次のヘッダーで付与します。

X-API-Key: <key>

APIキーについて

• APIキーは bpe_ から始まる文字列です。
• 発行された瞬間しか平文で表示されません。表示された値はその場でコピーして保管してください。ダッシュボード上で後から再表示することはできません。
• キーの失効・再発行は ダッシュボード から行います。値を忘れた場合や漏洩の懸念がある場合は、失効させて新しいキーを再発行してください。
• キーの発行には、事前にアカウントのメールアドレス認証を完了している必要があります(未認証の場合は発行時に 403 email_verification_required が返ります)。手順は クイックスタート を参照してください。

APIキーの取り扱い

APIキーは、そのアカウントの計算APIをすべて呼び出せる認証情報です。次の点に注意して取り扱ってください。

• リポジトリにコミットしない — ソースコードやリポジトリに直接書き込まず、環境変数やシークレット管理の仕組みで保持してください。
• クライアントサイド(ブラウザ)から直接呼ばない — ブラウザ上のJavaScriptに埋め込むと、閲覧者にキーが露出します。サーバーサイドを経由して呼び出す構成を推奨します。

認証エラー

APIキーが未指定、または無効な場合、リクエストは 401 で拒否されます。エラーレスポンスの形式や、その他のエラーコードについては エラーとレート制限 を参照してください。