Introduction¶

Application Programming Interface (API) is a connection between computers or between computer programs.

This document provides instructions on how to create and apply API user tokens with Postman for Acquia Web Governance.

In contrast to a UI (user interface), which connects a computer to a person, an API connects computers or pieces of software to each other.

Web Governance supports API use. The API can be based on the customer location. Web Governance has 3 APIs.

Visit the Developers article for the most updated information about API user setup.

To use the Web Governance API, your application must provide user credentials (the token) through an authentication software program (such as postman). The API user account can only be used for API access. It is recommended that you create a new user account specifically for this purpose and assign the API user scope to it with the free-text field.

The responsibility and troubleshooting for API calls lies solely with the customer. Acquia cannot assist or troubleshoot beyond the topics in this article.

Prerequisites¶

Acquia is unable to support or troubleshoot API calls. This function is solely a customer responsibility.

An API token allows access to domain code. APIs are not intended to be used directly by individuals (end users). Only a programmer or developer should use APIs, when they need to implement the Web Governance API in other applications or CMS systems, for example.

Visit the Developers article for the most updated information about API user setup.

The API tokens dashboard¶

The API tokens dashboard is a list of current API tokens for the domain. 

The following information about the tokens is presented in a list with the column headers:

• API URL: The URL where the token has access.
• Description: A description of the access that is granted, as provided during token setup.
• Access: The scope of the user permissions.
• Token: The API token, click the double document icon to copy the token to your clipboard.
• Actions: Click the kebab menu and select an action from the expanded selection:
  • Delete API token: Select this option to remove the user, including the token and scope. A pop-up message box requests confirmation, click OK.
  • Revoke API token: Select this option to revoke the token. A dialog box requests confirmation, click Revoke.

A new token is created. The existing token is replaced with a new token.

Add an API token¶

1. Click Admin Settings (the gear icon) on the top menu bar. 

   The system opens the Admin dashboard page.

2. Click Integrations on the left menu and select API Tokens.

   The system opens the API tokens dashboard.

3. Click +Add API token, on the top right side of the page. 

   The system opens the Add API token dialog.

4. Provide the following information:
   • Scope* (required): Select the scope for the new token:
     • CMS: This token allows the user to access the CMS user type with the API. CMS permissions are restricted to:
       • index/conceal domains
       • get domain
       • index domain pages
       • get/scan domain page
     • Customer: This token provides customer permissions to the user with the API. Customer tokens cannot be used to edit the account, they can only be used to edit contents on a modular level. Customers must contact a site admin and make a request for the API token.
     • Admin: This token provides full permissions with the API. Admins have permissions to:
       • GET
       • POST
       • DELETE
       • PATCH
   • Description*: A free-text field. Enter, for example, a description for this token, an email address to specific users or agencies in order to verify API token requests, and any other relevant information.
5. Click Save to add the token and close the dialog.

The API tokens dashboard¶

The API tokens dashboard lists current API tokens for the domain. The following information about the tokens is presented with the column headers:

• API URL: This field indicates the URL where the token has access.
• Description: This field provides a description of the access that is granted, as provided during token setup.
• Access: This field indicates the scope of the user permissions.
• Token: This field indicates the API token, click the double document icon to copy the token to your clipboard.
• Actions: This field provides the options to delete or revoke a token. Click the kebab menu and select an action from the expanded selection:
  • Delete API token: Remove the user, including the token and scope. A pop-up message box requests confirmation, click OK.
  • Revoke API token: Click to revoke the token. A dialog box requests confirmation, click Revoke.

A new token is created. The existing token is replaced with the new token.

Revoke an API token¶

1. Click Admin Settings (the gear icon) on the top menu bar. 

The system opens the Admin dashboard page.

2. Click Integrations on the left menu and select API Tokens.

The system opens the API tokens dashboard.

3. Click the kebab menu and select Revoke API token. A pop-up message box requests confirmation, click Revoke.

A new token is created and replaces the existing token.

Delete an API token¶

1. Click Admin Settings (the gear icon) on the top menu bar. 

The system opens the Admin dashboard page.

2. Click Integrations on the left menu and select API Tokens.

The system opens the API tokens dashboard.

3. Click the kebab menu and select Delete API token. A pop-up message box requests confirmation, click OK.

   The token is deleted.