コンテンツにスキップ

Re:Earth プロダクト

その他

Re:Earth Docs

プロダクト

JP
日本語 English

FAQ

更新日

セットアップ・基本

Section titled “セットアップ・基本”

Q: 複数のプロジェクトで同じインテグレーションを使えますか？

はい、1 つのインテグレーションを複数のプロジェクトに接続できます。ただし、プロジェクトごとに接続の設定が必要です。

Q: インテグレーショントークンと APIキーは何が違いますか？

インテグレーショントークンはインテグレーションAPI（読み書き・管理操作）で使用するトークンです。APIキーはパブリックAPI で非公開プロジェクトにアクセスする際に使用します。用途が異なるため、それぞれ適切な場面で使い分けてください。

Q: API のベース URL は何ですか？

APIベース URL
インテグレーションAPIhttps://api.cms.reearth.io/api/{workspace}/projects/{project}/
パブリックAPIhttps://api.cms.reearth.io/api/p/{workspace}/{project}/

アイテム操作

Section titled “アイテム操作”

Q: アイテムを作成したのにパブリックAPI で取得できません。なぜですか？

インテグレーションAPI で作成したアイテムはデフォルトで 下書き 状態になります。パブリックAPI で取得できるようにするには、以下のエンドポイントでアイテムを公開する必要があります。詳しくは インテグレーションAPI を使ってデータを公開する を参照してください。

POST /{workspace}/projects/{project}/models/{model}/items/{itemId}/publish

Q: フィールドキーはどこで確認できますか？

Re:Earth CMS の管理画面でモデルのスキーマ設定を開くと、各フィールドのキーを確認できます。また、以下のエンドポイントでスキーマを取得することでも確認できます。

GET /{workspace}/projects/{project}/models/{model}/schema.json

Q: 一度に取得できるアイテムの最大件数は何件ですか？

1 リクエストあたり最大 100 件です。perPage パラメータで件数を指定できます（デフォルト： 50 件）。100 件を超えるデータを取得する場合は、page パラメータを使ってページネーションで取得してください。

Q: アイテムを特定の条件で絞り込んで取得できますか？

インテグレーションAPI では、POST /items/filter エンドポイントを使って条件フィルタが使えます。テキスト・数値・日時・ステータスなど様々な条件タイプに対応しており、and / or で複数条件を組み合わせることもできます。なお、パブリックAPI にはフィルタ機能はありません。絞り込みが必要な場合はインテグレーションAPI を使用してください。詳しくは インテグレーションAPI でアイテムをフィルタして取得する を参照してください。

パブリックAPI

Section titled “パブリックAPI”

Q: 認証なしでアクセスできるのはどのような場合ですか？

公開設定されたプロジェクトであれば、認証なしでパブリックAPI にアクセスできます。非公開プロジェクトの場合は、Authorization ヘッダーに APIキーを付与することでアクセスできます。

Q: GeoJSON で取得しても features が空になります。

モデルに GeoJSON Geometry 型のフィールドが定義されていないと、features が空になります。CMS の管理画面でモデルのスキーマ設定を確認し、ジオメトリフィールドが追加されているか確認してください。

Webhook

Section titled “Webhook”

Q: Webhook を設定したのに通知が届きません。どこを確認すればよいですか？

以下の点を確認してください。

  1. Webhook URL が正しく設定されているか
  2. URL が http:// または https:// で始まっているか
  3. 受信サーバーが POST リクエストを受け付けているか
  4. 受信サーバーが 10 秒以内に 2XX レスポンスを返しているか
  5. 対象のイベントが Webhook の設定で有効になっているか

ローカル環境でテストする場合は、ngrok などのトンネリングツールを使って外部からアクセスできる URL を用意してください。

Q: Webhook のペイロードはどこで確認できますか？

テスト目的であれば、webhook.site で一時的な URL を発行すると、受信したペイロードをブラウザ上でリアルタイムに確認できます。

エラー対処

Section titled “エラー対処”

Q: 401 Unauthorized が返ってきます。

Authorization ヘッダーが正しく設定されているか確認してください。

Authorization: Bearer <your_integration_token>

Bearer とトークンの間にスペースが必要です。トークンが正しいにもかかわらずエラーが続く場合は、トークンを再発行してください。

Q: 400 Bad Request が返ってきます。

リクエストボディの構造が正しくない場合に返ります。以下を確認してください。

  • fields の key が CMS 側のフィールドキーと一致しているか
  • fields の type がフィールド型と一致しているか
  • JSON の構文が正しいか（カンマ、クォート、ネスト）

Q: 404 Not Found が返ってきます。

URL に含まれる workspace / project / model の ID またはエイリアスが正しいか確認してください。また、パブリックAPI の場合はモデルが公開設定になっているかも確認してください。