Skip to content

認証

API はユースケースに応じて3つの認証方法をサポートしています。

API キー

サーバーサイド統合用です。API キーページからキーを生成し、X-Api-Key ヘッダーで渡します:

http
X-Api-Key: bws_a1b2c3d4e5f6...

API キーはすべての API エンドポイントへのフルアクセスを持ちます — アップロード、削除、ファイル一覧、設定管理。クライアントサイドのコードには決して公開しないでください。

TIP

API キーには有効期限がありません。複数のキーを作成し、個別に取り消すことができます。

JWT Bearer トークン

Web ダッシュボードと Cognito 認証セッション用です。Authorization ヘッダーでトークンを渡します:

http
Authorization: Bearer eyJhbGciOiJSUzI1NiIs...

JWT トークンは、ユーザーが IPFS Ninja ダッシュボードからサインインする際に AWS Cognito によって発行されます。自動的に有効期限が切れ、直接の API 統合には適していません — API キーを使用してください。

署名付きアップロードトークン

API キーを公開せずにクライアントサイドアップロードを行うためのものです。Authorization ヘッダーでトークンを渡します:

http
Authorization: Signed sup_a1b2c3d4e5f6...

署名付きトークンは期限付きで、アップロード操作にのみ限定されています。ブラウザやモバイルアプリケーションに安全に埋め込めます。サーバーで POST /upload/signed-url を使用してトークンを生成し、クライアントに渡します。

署名付きアップロードトークンの作成、一覧表示、取り消しの詳細は署名付きトークンをご覧ください。