パブリックAPI
Web サイトや地図アプリケーション、公開フォームから公開範囲のデータを閲覧・作成します。
パブリックAPI とは概要
更新日
Re:Earth CMS は、プロジェクト単位でコンテンツ・構造・公開状態を管理し、外部アプリケーションや外部システムと連携するためのヘッドレス CMS です。外部からのアクセスには、公開範囲のデータを閲覧・作成するためのものと、CMS 内のリソースを管理・操作するためのものがあります。そのため Re:Earth CMS では、目的に応じて パブリックAPI・インテグレーションAPI・Webhook を提供しています。それぞれの特徴は次のとおりです。
| 連携方法 | 用途 | 認証 |
|---|---|---|
| パブリックAPI | 公開範囲のデータを外部から閲覧・投稿 | 公開プロジェクトは不要。非公開プロジェクトは APIキーで追加可能 |
| インテグレーションAPI | 外部システムとの連携・CRUD 操作全般 | インテグレーショントークン必須 |
| Webhook | CMS 内のイベントを指定 URL へ通知 | シークレットによる署名検証 |
より詳しい技術情報は DeepWiki をご覧ください。
インテグレーションAPI
バックエンドサーバーからプロジェクト・モデル・スキーマ・アイテム・アセットを管理します。
インテグレーションAPI とはWebhook
アイテムやアセットが変わった瞬間に、CMS から自分のサーバーへ通知させます。
Webhook とはパブリックAPI
Section titled “パブリックAPI”公開範囲のデータを外部アプリケーションから閲覧・作成するための API です。Web サイトや地図アプリケーション、公開フォームなど、フロントエンドから直接利用する用途に向いています。JSON・CSV・GeoJSON 形式で取得でき、Re:Earth Visualizer などでの表示にも使えます。
ただし、既存データの更新・削除や、モデル・スキーマの変更はできません。
インテグレーションAPI
Section titled “インテグレーションAPI”外部システムやバックエンドサーバーから CMS 内のリソースを管理・操作するための API です。アイテムやアセットに加え、プロジェクト・モデル・スキーマなど CMS を構成するリソース全般を扱えます。
インテグレーショントークンは強い権限を持つ認証情報のため、フロントエンドに露出させず、バックエンドサーバーなど安全な環境で管理する必要があります。
Webhook
Section titled “Webhook”CMS 内のイベント（アイテムの作成・更新・公開、アセットのアップロード・削除など）を、指定した URL へリアルタイムに通知する仕組みです。API のように CMS へリクエストするのではなく CMS 側から知らせるため、データ同期や外部ワークフローの自動化に向いています。
利用には、通知を受け取るサーバーの用意と、必要に応じた署名検証の実装が必要です。