コンテンツにスキップ
JP

パブリックAPI の使い方(書き込み)

更新日

このページでは、パブリックAPI を使ってアイテムを作成(POST)する方法を説明します。

事前準備:パブリックAPI を有効にする

Section titled “事前準備:パブリックAPI を有効にする”

パブリックAPI でモデルのデータを投稿できるようにするには、パブリックAPI ページの 書き込み タブでそのモデルを有効にする必要があります。

  1. プロジェクトの パブリックAPI を開きます

  2. 書き込み タブを選択します

  3. 許可済みオリジンを少なくとも1つ追加します。ブラウザからのリクエストは、指定されたオリジンからのみ受け入れられます

  4. 対象モデルの「有効」トグルをオンにします

  5. 変更を保存 ボタンをクリックします

    Re:Earth CMS の Public API ページ。Posting タブが選択され、Allowed Origins に許可済みオリジンが1件登録され、対象モデルの POST API Enable トグルがオンになっている状態

画面の Copy ボタンを押すと、curl リクエストをコピーできます。

POST /{model}/items エンドポイントに JSON でフィールドを指定すると、新しいアイテムを作成できます。認証は不要です。<workspace_id_or_alias> などの山括弧の部分は、実際の値に置き換えてください。fields のキーと値は、対象モデルのフィールド定義に応じて変わります。以下はサンプルです。

Terminal window
curl -X POST 'https://api.cms.reearth.io/api/p/<workspace_id_or_alias>/<project_id_or_alias>/<model_id_or_key>/items' \
-H 'Content-Type: application/json' \
-d '{
"fields": {
"<field-key-1>": "<value-1>",
"<field-key-2>": "<value-2>"
}
}'