API settings | AD Web Docs

Set the AD Web REST API route, turn the Swagger API interface on or off, and create API key pairs.

AD Web includes a REST API for integrating with other systems. This page shows you how to set the API route, use the built-in API interface and create the key pairs that authenticate your API calls. For the endpoints, see the API reference.

The API Settings page with the API Route field and API Interface toggle

API route#

The API route is the path segment your API calls use. The default is restapi. You can change it so that your API isn't on a predictable path.

Next to API Route, select Edit.
Enter the new route and save.

For example, if you change the route to adwebapi, your API is at https://adweb.yourdomain.com/adwebapi.

API interface#

The API interface is an OpenAPI (Swagger) page for development. Use it to look up endpoints and test API calls inside AD Web, without tools such as Postman.

Turn on API Interface, then open https://adweb.yourdomain.com/swagger/index.html.

The Swagger API interface listing the AD Web REST API endpoints

Warning

Turn off the API interface in production. Turn it on only when you need it for reference, and turn it off again afterwards.

API keys#

AD Web authenticates API calls with key pairs. You can create as many key pairs as you need.

The API Keys list

Create a key pair#

Select Create New.
Enter a Name for your reference. AD Web generates the API Key and API Secret.
Select Copy Keys to copy them now, or save and copy them from the grid later.

Send the key and secret in the ApiKey and ApiSecret headers of every API call. See Authentication.