REST API: System Integrator's Guide

Explore and Test the APIs

Archibus recommends using Postman as a tool to explore and test Web Central REST APIs.

Install and configure Postman

Download and install the Postman app from https://www.postman.com/downloads/.

Start the app and create a free account.

Create a collection

Create a Postman collection. Postman collections are groups of related REST API requests. Typically, you would create one collection per Web Central API, e.g. Service Desk API.

 

1. Create a new collection.

2. Give it a descriptive name.

3. Add one of more Requests.

For each request, enter:

• HTTP verb (GET, PUT, etc)

• API URL

• Content-Type header = application/json

• Query parameters required by the API

• Body parameters required by the API

 

Configure OAuth2 Access Token

Web Central REST APIs require OAuth2 access token. Postman can obtain the token from the authorization provider, e.g. Okta.

In Postman:

1. Select the “Authorization” tab.

2. Click “Get new Access Token.”

3. Select “Grant Type” = Client Credentials.

4. Copy Access Token URL, Client ID, and Client Secret values from authorization provider.

5. Click “Request Token”.

Test

Click Send, wait for the request to complete, and examine the response status (200 OK) and body:

If the response status is not 200 OK, review the Web Central console and log.

Run Web Central from Eclipse if you want to set breakpoints and debug the API implementation.