In the API settings screen, you can change various settings related to the API.
You can access the API settings screen after selecting various APIs from the sidebar.
In the basic information settings screen, you can change the API name and endpoint name.
This is the name used to identify the API. It is used for display in the management screen.
This is the value included in the URL for calling the API.
In the API Schema screen, you can add fields to the API schema and modify the settings of the created schema.
After creating a field, the settings can be changed at any time (with some exceptions). However, in such cases, the response from the Content API may change, which could affect the systems you are using. Please be cautious when making changes if you are already in operation.
A unique ID for each field. It will be the property name in the API response.
This will be displayed when entering content.
Specifies the input form format when entering content.
You can choose from various types such as text fields, rich editors, image fields, and more.
The type of a field that has been created cannot be changed. If you want to change it, please delete the field first and then create a new one.
In addition to required input fields, detailed settings can be configured for each field.
By checking this option, you can set the field as "required" when submitting content. This can be set for all fields.
Detailed settings can be configured for each field. Click on "Detailed Settings" at the right end of each field to open the settings screen.
Below is an example of a text field.
To reflect the settings in the API schema, close the settings screen by clicking "Close" and then click the "Change" button.
If set to ON, data entry for the field is mandatory.
This is the description displayed at the top of the field in the Administration console.
You can set the default value for each field when creating new content. Please check the details page for each field for more information.
When setting default values, please keep the following points in mind:
You can restrict the available buttons in the toolbar.
You can select registered colors when setting the text color. Enabling "Show only color presets and hide the color picker" will allow you to select only the preset colors registered in advance.
For more details on how to use it, please refer to "How to Use the Rich Text Editor".
You can select registered text sizes when setting the text size. For more details on how to use it, please refer to "How to Use the Rich Text Editor".
You can assign registered class names to specific text elements. For more details on how to use it, please refer to "How to Use the Rich Text Editor".
You can set default values at the time of submission.
You can limit the available decoration buttons.
If enabled, line breaks will use <br> tags. If disabled, paragraphs will be separated using <p> tags.
If enabled, the <img> tag will include width and height.
For information on how to use Custom Status, please refer to the page below.
For information on setting the Content ID, please refer to the following page.
For information on how to use the Page Preview, please refer to the following page.
For information on how to use Webhook, please refer to the following page.
For information on how to use API IP Restriction, please refer to the following page.
Since this is a dangerous operation, please carefully consider the impact before proceeding. Once the deletion operation is performed, it cannot be undone.
This will delete all contents that exist in the API.
Please note that you cannot delete all contents if any of the following conditions apply. If you wish to delete, please modify the contents that meet the conditions.
This will delete the API. Once deleted, the corresponding API will no longer be available.
Please note that you cannot delete the API if any of the following conditions apply. If you wish to delete, please modify the contents or fields that meet the conditions.
