In order to use Yext's API, admins must first obtain a shared authentication token. Account administrators can generate an API token by following the steps below.

Generating an API Token

Deactivating an API Token

 

Generating an API Token

1. From the Administration view, select Settings > Integrations. Then click Generate Token.

2. Complete the information in the pop-up window. Then click Generate.

• Token Name - indicate what the token will be used for. This name helps to provide
  context around the usage of the token when viewed in the list.
• Access - select Full Organization or Single Workspace.
  • If Full Organization is selected, skip selecting Workspace Name.
  • If Single Workspace is selected, search and select the appropriate workspace from the Workspace Name dropdown menu.
• Scopes - multiple scopes can be selected.
• Permissions - Select either Read/Write or Read Only from Permissions

3. A new token will appear in the API Tokens list. Copy the token string using the Copy Token button under the Action tab and save it to a secure location. This token will be used to authenticate for all API requests.

 

Deactivating an API Token

Keep in mind that deactivating a token will permanently revoke it.

1. From the Administration view, select Settings > Integrations.

2.  Select the Pencil icon under the Action column for the token you would like to deactivate.

3. Select the Deactivate button. To display the current API token, select the Eye icon (Show token) link to the right of the API Token.

The entry for the token is moved down the list where all Inactive tokens are listed with a minus sign and greyed out, indicating the status is set to Inactive.

For more information view the Authentication section of the Developer Guide. (Password: HearsayDocs)