Traditional API ID / Key authentication continues to be supported.
This method is suitable for existing server-to-server integrations where credentials are securely managed. OAuth is recommended for new third-party integrations because it allows a user to approve a specific application and later revoke that individual connection without changing a permanent API key.
Possession of an API ID and API Key can potentially provide broad read and write access to website data, depending on the API configuration. Treat API credentials as sensitive information.
Enabling the API / Obtaining Legacy Access Keys
- Log in to the CMS / Control Panel.
- Navigate to the API Setup Area.
- Alternatively, navigate to the API area and select Our JSON REST API interface, or add the JSON API plugin.
- Click Enable API.
- An API ID and API Key will be provided.
The API ID identifies the API configuration, including the website and the default page used for data creation where a page is not otherwise identified in the submitted JSON.
The API Key can be changed through the API configuration.
Using the API ID and API Key
Provide apiID and apiKey as HTTP request headers or request parameters. Names are case sensitive. Values are examples
- apiID = 123456
- apiKey = 234GH-SAMPLE-GH352