シタミ
最終更新: 2026-04-25 ・ 3 min read

REST APIの使い方

シタミの Delivery API は REST ベースで設計されています。すべてのレスポンスは JSON 形式で返却され、Bearer トークンによる認証で利用できます。

ダッシュボードのAPIドキュメント画面
ダッシュボードの「APIドキュメント」でエンドポイント仕様を確認できます

1. ベース URL

https://your-domain.com/api/v1

2. 認証

すべてのリクエストに Authorization ヘッダーとして API キーを含めてください。

Authorization: Bearer <YOUR_API_KEY>
注意

API キーは秘密情報です。クライアントサイドのコードに直接埋め込まないでください。環境変数経由でサーバーサイドからのみ使用してください。詳しくはAPIキーの管理を参照してください。

3. エンドポイント一覧

エントリ一覧の取得

GET /api/v1/sites/{siteId}/collections/{collectionId}/entries

クエリパラメータ:

パラメータ型説明
limitnumber取得件数（最大100、デフォルト50）
offsetnumberスキップ件数（デフォルト0）
keywordstringキーワード検索
localestringロケール（例: ja, en）
populatestring展開するリファレンスフィールドID（カンマ区切り）

単一エントリの取得

GET /api/v1/sites/{siteId}/collections/{collectionId}/entries/{entryId}

レスポンス例

{
  "data": [
    {
      "id": "entry_xxx",
      "collectionId": "col_xxx",
      "status": "published",
      "data": {
        "title": "記事タイトル",
        "body": "本文テキスト"
      },
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-02T00:00:00.000Z"
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

4. ステータスコード

コード意味
200 OKリクエスト成功
201 Createdリソース作成成功
400 Bad Requestリクエストパラメータが不正
401 UnauthorizedAPI キーが無効または未指定
403 Forbiddenスコープ不足
404 Not Foundリソースが存在しない
429 Too Many Requestsレート制限超過
500 Internal Server Errorサーバーエラー

5. レート制限

プランリクエスト数 / 月
Basic10,000
CMS100,000
AI-Pro1,000,000

レート制限に達した場合、429 Too Many Requests が返されます。レスポンスヘッダーの Retry-After を確認してください。

ヒント

頻繁に呼び出すデータは ISR や CDN キャッシュを併用するとレート制限の消費を大幅に減らせます。

次のステップ