コンテンツにスキップ
JP

パブリックAPI とは

更新日

パブリックAPI は、Re:Earth CMS で公開設定されたデータを読み取り、作成できる API です。Web サイトや外部サービスは、この API を通じて次のようなデータを取得できます。

  • 公開設定されたモデル
  • アイテム(コンテンツ)
  • アセット(画像・ファイルなど)

データの更新・削除、スキーマの変更など管理操作が必要な場合は、インテグレーションAPI を使用します。

パブリックAPI の主な特徴は次のとおりです。

特徴内容
データの閲覧・作成が可能公開設定されたモデル・アイテム・アセットのみにアクセス可能。データの作成も可能(ただし Asset・Reference・Tag・Group・GeometryEditor・GeometryObject 型のフィールドは投稿に対応していません)。
認証不要公開データであれば APIキーなしで利用可能。非公開データは取得できません。
RESTful API標準的な HTTP メソッド(GET / POST など)を使う REST 準拠設計。

パブリックAPI の使い方(読み取り) に進み、公開設定から最初の読み取りリクエストまでを試してみましょう。