Biamp Workplace API

Overview

Biamp Workplace uses GraphQL for API integration with third-party solutions. The API comes with built-in documentation, and additional information on GraphQL is available at: GraphQL | A query language for your API

This article covers connection requirements and uses the Postman API platform for connection verification and query.

Setting up and verifying a connection

1. Download and install Postman.

2. Inside Postman, select New (1) at the top of the left pane, and then select GraphQL (2) as the API.

 

3. Enter the URL: https://api.evoko.app/graphql

 

4. Switch to the Authorization tab, and select OAuth 2.0 as the Authorization Type.

 

5. On the Authorization tab, scroll down to the section Configure New Token, and enter the following values :

1. Token Name: Workplace (or any name you prefer)

2. Grant type: Authorization Code (With PKCE)

3. Set the flag to Authorize using browser

4. Auth URL: https://iam.workplace.biamp.app/oauth/v2/authorize

5. Access Token URL: https://iam.workplace.biamp.app/oauth/v2/token

6. Client ID: 283590591013552185@platform

7. Scope: openid profile email urn:zitadel:iam:user:metadata offline_access

 

6. Go to the bottom of the page and select Get New Access Token.

 

7. Selecting Get New Access Token opens a new web browser window. Sign in on the window using your Biamp Workplace credentials.

 

8. After a successful authentication, return to Postman.

• NOTE: During the authentication process, the browser will open a popup window, make sure you do not block this from opening.

 

9. Select Use Token. This finishes setting up the connection to the Biamp Workplace API.

 

10. To verify the connection is working, go to the Postman Schema tab (1), and press the refresh button under Using GraphQL introspection (2).

 

If the refresh is successful you are ready to set up a query.

 

Query

The example below shows a query for the name of the profile used for verification.

1. Select the Query tab (1), then find the profile User section (2), and expand this.

2. Set the selection flag for the name String! option (3).

3. Verify the query syntax (4), and press Query (5) to send the API request to Biamp workplace.

4. The query result can be seen in the result window (6).

You are now ready to create queries. GraphQL is intuitive, largely self-explanatory, and information resources are available online. 

 

Reach out to support@biamp.com for further questions.