What is Integration API?

Integration API lets external services manage and operate on data inside Re:Earth CMS. Once authenticated, it supports operations such as:

• Retrieving and managing project data
• Creating, updating, and deleting models, items, and schemas
• Registering assets, adding comments, and other operations

If you want to read or create published data without authentication, use Public API instead.

Here are Integration API’s key characteristics.

Characteristic	Description
Create, update, and delete any resource	Items, assets, models, and any other resource in the CMS can be created, updated, and deleted. Unpublished models, items, and assets are also accessible.
Authentication required	Requires authentication with an integration token.
RESTful API	A REST-compliant design using standard HTTP methods (GET, POST, and so on).

Caution

An integration token carries privileges equivalent to an admin. If it’s exposed on the client side, a third party could misuse it. You must manage the token on a backend server and call the API from there.

Next steps

Start with Creating an Integration to issue an integration token.

Related resources

• Getting started: Using Integration API — from issuing a token to your first request
• Reference: Integration API Reference