認証
Jobmore 企業向け公開 API のすべてのエンドポイントは、API キー認証を要求します。HTTP リクエストヘッダに、発行された平文キーを次の形式で付与してください。
Authorization: Api-Key <発行された平文キー>
各キーは特定の企業(Organization)に紐付き、その企業のリソースだけを操作できます。
ベース URL は https://jobmore.co.jp で、各エンドポイントのパスは
/api/v1/ で始まります。
API キーの発行手順
- 企業ダッシュボードにログインします。
- 「Security(セキュリティ)」設定を開きます。API キーの管理は、企業情報の編集と同等の 権限(オーナー、または企業設定の管理権限)を持つメンバーが行えます。
- 名前(任意で有効期限)を指定して、新しい API キーを発行します。
- 発行時に表示される平文キーを、安全な場所に保管してください。 平文キーは発行時に一度だけ表示され、以降は再取得できません。
発行ページ: 企業ダッシュボード
平文キーは秘密情報です。ソースコードや公開リポジトリに直接書かず、環境変数や
シークレットマネージャ等で管理してください。漏洩した場合は、ダッシュボードから
該当キーを失効(revoke)し、新しいキーを発行してください。
レート制限
リクエストは API キー単位で 100 リクエスト / 分 に制限されます。
超過すると 429 Too Many Requests が返ります。時間をおいて再試行してください。
エラー形式
エラー時のレスポンス本文は、次の形の JSON で返します。
{
"detail": "人間可読のエラー説明",
"code": "machine_readable_code",
"errors": { "field_name": ["フィールド単位のエラー"] }
}
errors はバリデーションエラー時のみ含まれます。code の例:
not_authenticated, permission_denied,
not_found, validation_error, throttled。