The API Server provides a range of services to iCM and your website. These services are delivered by distinct components called "workers" and include things like authentication, workflow and the forms service.
These articles introduce the API Server, then cover security, configuration, and the API Server Console.
Getting Started
Make your first call to the API Server and get results back straight away.
Making Requests
How to call workers from forms, end points, workflow processes and external applications.
iCM/API Servers
The iCM/API Servers section of iCM's System Configuration is where you can manage your iCM and API Servers.
API Server Security
API Server workers are assigned to keys. Keys define access to a worker, and allow IP restrictions and other security settings to be set up.
URLs, Keys and Authentication
This article explains how the API Server uses API keys, credentials, tokens, and the internal key.
API Server Console
The API Server Console shows details of calls to the API Server workers, including configuration, load, trace of actions and logs.
API Server and Worker Configuration
The API Server and it's workers are supplied with a default configuration. This can be managed from iCM.
Recommended Settings
If you are running the full Digital Platform, we recommend the following number of instances and threads per worker.
Asynchronous API Server Calls
The API Server supports asynchronous requests. This allows tasks to be performed in the future, while the client receives an initial response and can move on.
Share this page
