Swagger Documentation

Swagger lists the resources available in a REST API and the operations they can do. Out of the box Workplace AI provides dynamic Swagger documentation. If enabled on a staging or dry run environment you can access Swagger to get more API information.

Swagger should not be enabled on a live environment as it's a security hole.

Swagger helps develop products or integrations that use the Workplace AI backend.

Accessing Swagger Documentation

1

Open your browser.

2

Enter swagger.aiimi.cloud into the address bar.

3

Once the page loads you may need to update the server address in the URL. It should contain your Workplace AI instance.

For example, https://{domain}/api/index.html

---

Authentication

1

Expand POST /account/loginWithApiKey

2

Select Try it out to edit the schema values.

3

In the Request Body edit the application ID, application key, username and API key.

• This information should be entered between the quotation marks where it says "string".

4

Select Execute to run this.

• This will give you a bearer token.

• This bearer token is then sent with all subsequent requests.

5

Copy the bearer token from the Response Body. Do not include the surrounding quotes.

6

Select Authorize at the top of the Swagger page.

7

Add the copied bearer token and select Authorize.