インテグレーションAPI の使い方

このページでは、インテグレーショントークンをリクエストに付与し、インテグレーションAPI で CMS のデータへ認証付きでアクセスする方法を説明します。

インテグレーショントークンの発行

インテグレーションAPI は インテグレーショントークンを使って認証します。まずは Re:Earth CMS の管理画面で、対象プロジェクト（必要に応じてワークスペース）のインテグレーショントークンを発行してください。手順は インテグレーションの作成 を参照してください。

アイテム一覧を取得する（GET）

最初の動作確認として、インテグレーションAPI でアイテムの一覧を取得してみます。発行したインテグレーショントークンを Authorization ヘッダーに付与してリクエストします。<workspace_id_or_alias> などの山括弧の部分は、実際の値に置き換えてください。

curl

curl --location --request GET \
  'https://api.cms.reearth.io/api/<workspace_id_or_alias>/projects/<project_id_or_alias>/models/<model_id_or_key>/items' \
  --header 'Authorization: Bearer <your_integration_token>'

PowerShell

$TOKEN = "<your_integration_token>"
$WORKSPACE_ID = "<workspace_id_or_alias>"
$PROJECT_ID = "<project_id_or_alias>"
$MODEL_ID = "<model_id_or_key>"

$headers = @{
  Authorization = "Bearer $TOKEN"
  Accept        = "application/json"
}

$uri = "https://api.cms.reearth.io/api/$WORKSPACE_ID/projects/$PROJECT_ID/models/$MODEL_ID/items"
$resp = Invoke-RestMethod -Method Get -Uri $uri -Headers $headers
$resp

補足

フロントエンドから直接インテグレーションAPI を呼び出すと、開発者ツールでトークンが見えてしまいます。トークンを隠すには、バックエンドサーバー側でトークンを管理し、そこから API にアクセスする構成をおすすめします。

ヒント

次は インテグレーションAPI でアイテムをフィルタして取得する に進みましょう。