Skip to main content
Blob Storage は Authorization ヘッダーで 2 種類の認証情報を受け付けます。
  • API キー: アカウント設定で作成します。付与したスコープの範囲内で、すべてのルートで機能します。
  • アップロードトークン (squp_...): サーバーがアップロードトークンで発行する短期間有効なトークンです。アップロードしかできないため、ブラウザに渡しても安全です。
API の利用には利用規約および利用ポリシーが適用されます。
Blob SDK (@squarecloud/blob) が認証情報の送信を代行し、このリファレンスのすべてのルートをラップしています。

​
スコープ

API キーはスコープを持ちます。Blob Storage はそのうち 2 つを読み取ります。 ルートに必要なスコープを持たないキーは 403 MISSING_SCOPE を受け取ります。特定のアプリケーションに制限されたキーは Blob Storage にアクセスできず、403 RESOURCE_NOT_ALLOWED を受け取ります。
各連携には、必要なスコープだけを持つ専用のキーを割り当ててください。ファイルを配信するだけのバックエンドには blob:read、アップロードするだけのジョブには blob:write が必要です。

​
アップロードトークン

アップロードトークンはオブジェクトのアップロードとチャンクアップロードのルートでのみ受け付けられます。それ以外のルートは 403 UPLOAD_TOKEN_NOT_ALLOWED を返します。トークンは発行時に選択された名前、プレフィックス、公開範囲、サイズ、ファイル形式を固定し、有効期限が切れたとき、使用回数を使い切ったとき、または発行元の API キーが取り消されたときに機能しなくなります。

​
S3 ゲートウェイ

S3 ツールは API キーそのものを送信しません。API キーから導出されたアクセスキーのペアでリクエストに署名 (SigV4) します。ペアは S3 認証情報から取得し、S3 互換性をお読みください。

​
エラー

エラーレスポンスは { "status": "error", "code": "SOME_CODE" } の形式に従い、状況を説明する message が含まれることもあります。分岐は message ではなく、必ず code で行ってください。完全な一覧はエラーにあります。

​
グローバルエラー

どの Blob ルートも、次のエラーを返す可能性があります。

制限と制約

Square Cloud API の制限と制約について学びます。