認証

shinp.info APIはBearer認証とAPI Key認証の2つの認証方式をサポートしています。

Bearer認証（セッション）

ログイン済みユーザーはセッションCookieによって自動的に認証されます。SSR互換のため、Authorization ヘッダーによるBearer認証もサポートしています。

http

Authorization: Bearer <session_token>

外部アプリケーションからのアクセスには、API Keyを使用します。x-api-key ヘッダーにAPI Keyを設定してください。

http

x-api-key: <your_api_key>

API Keyはshinp.infoの設定画面から発行できます。

API Keyの有効性を確認するための認証付きヘルスチェックエンドポイントが利用可能です。

http

GET /api/v1/health
x-api-key: <your_api_key>

認証に失敗した場合、401 Unauthorized が返却されます。

json

{
    "type": "https://shinp.info/problems/unauthorized",
    "title": "Unauthorized",
    "status": 401,
    "detail": "認証に失敗しました。"
}