パブリックAPI設定

パブリックAPI設定は、プロジェクトのアイテムとアセットを外部に配信するための画面です。左メニューの パブリックAPI にあります。この画面は読み取りと書き込みの2つのタブで構成されます。

読み取り

モデルのデータを外部へ配信するための設定です。モデルごとの配信の切り替えと、APIキーの2つの欄があります。

モデルごとの配信

表には、プロジェクトのモデルが並び、末尾に「アセット」の行が付きます。アセットの行は、プロジェクトのアセットをまとめて配信するかどうかの設定です。列は次のとおりです。

列	内容
有効	そのモデル（またはアセット）を配信するかの切り替え。プロジェクトの公開範囲が「非公開」のときに表示されます
モデル	モデルの名前
エンドポイント	配信先の URL。URL の前に「GET」と表示されます

• プロジェクトの公開範囲が「公開」の場合は、すべてのモデルが配信の対象になります。切り替えの列は表示されません。
• プロジェクトの公開範囲が「非公開」の場合は、モデルごとに配信するかを選びます。

配信を有効にしたモデルは、エンドポイントを知っている人が誰でもデータを読み取れます。この状態のモデルは、APIキーの権限では制限できません。配信されるのは、ステータスが「公開済み」のアイテムだけです。

APIキー

APIキーは、プロジェクトの公開範囲が「非公開」の場合に、配信する範囲を制御するためのものです。プロジェクトの公開範囲が「公開」の場合は使えません。

一覧には「名前」と「キー」が表示されます。各キーが持つ項目は次のとおりです。

項目	内容
名前	キーを識別する名前
説明	キーの用途などの説明
APIキー	API リクエストに使う秘密のトークン文字列。再生成できます
権限	このキーで配信を許可するモデル・アセット

書き込み

外部から匿名でデータを送信できるようにする設定です。認証なしの送信を受け付けるため、送信元のサイトを限定します。送信を受け付けると、そのモデルに新しいアイテムがドラフトの状態で作られます。公開はされず、リクエストも作られません。この設定を変更できるのは、所有者と管理者です。

許可済みオリジン

送信を受け付けるサイトの一覧です。オリジンとは、https://example.com のように、通信方式とドメイン名までで Web サイトを識別する単位です。その先のページのパスは含みません。

この一覧との照合を受けるのは、Origin ヘッダーが付いた API リクエストです。受け付けるのは、一覧に登録したオリジンからのものだけで、オリジンを1つも登録していないときはすべて拒否します。サーバー上のプログラムやコマンドラインのツールのように、Origin ヘッダーが付かない API リクエストは、照合を受けません。オリジンは複数登録でき、登録済みの件数が表示されます。「すべてクリア」で全件を削除できます。

入力するのは、通信方式（http または https）とドメイン名までです。必要ならポート番号も付けられます。ページのパスやクエリを含む URL（例：https://example.com/form）は登録できません。サブドメインが複数ある場合は、1件ずつ登録します。形式に合わない値を入れると「有効なオリジンを入力してください（例：https://example.com）」と表示されます。末尾のスラッシュは、登録時に取り除かれます。

モデルごとの書き込み

表には、プロジェクトのモデルが並びます。アセットは対象外です。列は次のとおりです。

列	内容
有効	そのモデルへの書き込みを受け付けるかの切り替え
モデル	モデルの名前
エンドポイント	送信先の URL。URL の前に「POST」と表示されます
（見出しなし）	そのモデルへの API リクエストの例を cURL コマンドとしてコピーする「コピー」のボタン

許可済みオリジンを1つも登録していない場合、この表は操作できません。

API の呼び出し方

エンドポイントの構造・認証・リクエストの書き方など、実際の API の使い方は、CMS Developer Docs を参照してください。