Public API
Read and create published data from a website, a map application, or a public-facing form.
What is Public API?Overview
Last updated
Re:Earth CMS is a headless CMS that manages content, structure, and publication status on a per-project basis, and integrates with external applications and systems. External access falls into two categories: reading and creating published data, and managing or operating on resources inside the CMS. To cover both, Re:Earth CMS provides Public API, Integration API, and Webhook. Here’s how each one compares.
| Method | Purpose | Authentication |
|---|---|---|
| Public API | Read and submit published data from external sources | Not required for public projects. Can be added via an API key for private projects |
| Integration API | Integration with external systems and general CRUD operations | Requires an integration token |
| Webhook | Notify a specified URL of events inside the CMS | Signature verification with a secret |
For more in-depth technical information, see DeepWiki.
Integration API
Manage projects, models, schemas, items, and assets from a backend server.
What is Integration API?Webhook
Have the CMS notify your server the moment an item or asset changes.
What is a Webhook?Public API
Section titled “Public API”An API for reading and creating published data from external applications. It’s well suited to use directly from a frontend, such as a website, a map application, or a public-facing form. Data can be retrieved as JSON, CSV, or GeoJSON, and can also be used for display in tools like Re:Earth Visualizer.
However, it can’t update or delete existing data, or change models and schemas.
Integration API
Section titled “Integration API”An API for managing and operating on resources inside the CMS from external systems or backend servers. Besides items and assets, it can handle projects, models, schemas, and other resources that make up the CMS.
Because an integration token is a credential with strong privileges, it must never be exposed to the frontend and should be managed in a secure environment, such as a backend server.
Webhook
Section titled “Webhook”A mechanism that notifies a specified URL in real time when events happen inside the CMS, such as item creation, updates, or publication, or asset uploads and deletions. Rather than requesting data from the CMS as with an API, the CMS notifies you instead, which makes Webhook well suited to data synchronization and automating external workflows.
To use Webhook, you need a server ready to receive notifications, and, if needed, an implementation of signature verification.