You can create multiple APIs within the service.
This document explains how to create and manage APIs.
The maximum number of APIs you can create varies by plan.
This section explains the steps to create a new API.
First, in the left menu of the management screen, click the three-dot menu next to the "Content (API)" item and then click [Create New API].
This will display the API creation screen.
※If no API exists, the API creation screen will automatically appear after accessing the service.
When creating an API, you can choose from the following two methods:
Next, we will explain each method.
Click on [Decide on Your Own] in the API creation screen.
Then, proceed with the following steps.
Enter the basic information for the API.
Here, you will enter two items: "API Name" and "Endpoint".
The API name is used to identify each API in the management screen.
The endpoint is the value that corresponds to the last part of the API endpoint path.
The input conditions for the endpoint are as follows:
Select the API type.
Here, you can choose between "List Format" or "Object Format" for the API response format.
This handles multiple pieces of content.
It is suitable for managing multiple contents such as announcements and blogs.
The API can retrieve array data as shown below.
[ { message: 'Good morning' }, { message: 'Hello' }, { message: 'Good evening' } ]This handles a single piece of content.
It is suitable for managing single contents such as configuration information or individual page information.
The API can retrieve object data as shown below.
{ title: 'Profile', profile: 'I am studying Headless CMS' }Define the API schema.
In defining the API schema, you will enter the following three items.
A unique ID for each field. This will be the property name in the API response.
This will be displayed when entering content.
This specifies the input form format when entering content.
You can choose from various types such as text fields, rich editors, and image fields.
For details on configuring the API schema, please refer to the "API Settings" page.
Finally, clicking on [Create] will complete the API creation.
When creating from a template, you can choose from the following three templates. Different APIs will be created for each template.
Clicking on the desired template will start the creation process.
After a while, the API will be created automatically.
Additionally, several sample contents have been uploaded for each API.
You can group the created APIs into API groups. This is useful when managing multiple sites with a single service.
The API group is a feature available with the Team, Business, and Enterprise plans.
For details on the features available with each plan, please refer to the pricing page.
In the left menu of the management screen, click the three-dot menu next to the "Content (API)" item and then click [Create New API Group].
Enter the group name for the group you want to create and click [Create].
An API group with the same name cannot be created.
By dragging and dropping the API, you can group APIs into an API group.
Hover over the API group and click the three-dot menu, then click [Edit Group Name].
Edit the group name and click [Change] to apply the changes to the group name.
Hover over the API group and click the three-dot menu, then click [Delete Group].
In the confirmation dialog, click [OK] to delete the API group.
You cannot delete an API group if it contains APIs.
Please move all APIs to another API group before deleting it.