Standard API access credentials

As a standard API access user, you can create and manage credentials for a Toast location or locations in a management group. The type of access you have to edit and view standard API access credentials depends on your credentials ownership and permissions. There are three types of credentials access:

• Full access (no icon)

• Read-only access (warning icon)

• Locked access (lock icon)

Permission	Ownership
Manage Integrations permission	You created the credentials.	You did not create the credentials.
You have access to all locations that use the same set of credentials.	Full access Allows for editing and reading of a credential set.	Full access Allows for editing and reading of a credential set.
You do not have access to all locations that use the same set of credentials.	Read-only Allows for only reading of a credential set.	Locked Does not allow for editing or reading of a credential set.

The following image shows the three credentials access types.

Creating standard API access credentials

The following procedure describes how to create standard API access credentials in Toast Web.

Note

You can configure up to 100 sets of unique standard API access credentials per management group in Toast Web.

To create Standard API credentials

1. Access Toast Web.

2. Choose Integrations > Toast API access > Manage credentials to open the Manage credentials page.

   Note

   An active subscription to Toast Restaurant Management Suite Essentials or higher is required for every location you want standard API access for.

3. On the Manage credentials page, navigate to the Create new credentials button.

4. Select the down arrow and select Standard API. This opens the New Credentials page.

   

5. On the New Credentials page, you can:

   • View a list of the APIs that you will have read-only access to.

   • View links to documentation.

   • Enter a credential name. Toast support recommends this be a name that you can easily reference.

   • Select the scopes for the actions you want your Toast API client to be allowed to perform. For more information, see Standard API access scopes.

   • Select the location(s) that you want read-only API access to. You can choose to select all the locations in your management group or use the dropdown menu to select individual locations. Select the Apply button to select your location(s).

     

     Note

     If a location displays a locked icon and is grayed out, this indicates that the location does not have access to Toast Restaurant Management Suite Essentials or higher. For more information, see this Toast Central article.

6. Select the Confirm button. This navigates you to the Credentials page. You can view your new credentials on the Credentials table on the Manage Credentials page.

   

   An email is sent confirming that standard API access has been activated for your selected location(s). The email also includes the names and GUIDs of the location(s) you have standard API access credentials for and a link to view your credentials in Toast Web.

   Note

   You use the GUID to make Toast API requests. GUIDs are also referred to as the Toast-Restaurant-External-ID or restaurantGuid. You can retrieve GUIDs using the Partners API.

Viewing standard API access credentials

You can view your standard API access credentials on the Manage credentials page in Toast Web. The Manage credentials page displays the following information:

• Link to create new credentials

• Table of Toast API credentials with the following information:

  • Credential name

  • API access type

  • Number of locations with the API access type

  • Date and time the credentials were last updated

  • The email of the Toast user who last updated the credentials

  • Edit icon (pencil)

• Links to documentation

Managing standard API access credentials

You can manage your standard API access credentials on the Manage credentials page in Toast Web. To view and edit your credentials, select the edit icon (pencil) next to the credential name to open the Credentials page. On the Credentials page, you can view information and complete various actions. From the Credentials page, you can:

• View the credential name

• View the number of locations included in the credentials set

• View the number of scopes included in the credentials set

• Edit credentials

• Delete credentials

• Edit group or location IDs

• View credentials in JSON format

• Copy API Access URL

• Copy Client ID

• Copy user access type

• Rotate client secret

Editing standard API access credentials

To edit your standard API access credentials, select the Edit credentials button to open the Edit credentials page. On the Edit credentials page, you can edit your credential name and change the location(s) the credentials have access to. Select the Confirm button to confirm and save your changes.

Editing group or location IDs

Group and location IDs are account numbers that you can use to map restaurants in your integration. After populating a group or location ID for the location, you can retrieve this value using the restaurants API. For more information, see Using location and group identifiers.

Viewing standard API access credentials in JSON format

You can choose to view your credentials in JSON format. JSON is short for JavaScript Object Notation. You can choose to copy your credentials and include them in the header of your API requests.

Copying credentials and other information

You can choose to copy the following information to your clipboard for easy reference. You can copy:

• API Access URL

• User access type

• Client ID

Select the Copy icon to copy the information.

Rotating client secret

Note

Active authentication tokens generated using your credentials will continue to be valid until they expire or are replaced with new authentication tokens.

A client secret is a private string assigned by Toast to verify the identity of the partner application to the service API when the application makes requests to Toast services. It is good security practice to rotate your client secret to minimize the impact of potential breaches and to reduce the possibility of compromised credentials. For more information, see Credential storage guidelines.

Note

Rotating your client secret may cause disruptions to any integrations using the same credentials.

To rotate your client secret:

1. On the Credentials page, select the Rotate button. This opens the Ready to rotate the client secret dialog.

2. In the Ready to rotate the client secret dialog, confirm you want the existing client secret to expire and want to create a new client secret. To confirm, type ROTATE SECRET in the text field.

3. Select the Continue button. Your new client secret appears. Toast support recommends you copy and store your client secret in a secure location, such as a password manager. For more information, see Credential storage guidelines.

4. Select the I have copied and saved the client secret checkbox to finish rotating your client secret. The Credentials page displays the date and time your new client secret was created.

   An email is sent notifying you that your client secret has been rotated with the name of the Toast user who rotated the secret.

Deleting standard API access credentials

Note

Deleting standard API access credentials is permanent. You cannot restore deleted credentials.

To delete your standard API access credentials, select the Delete credentials button on the Credentials page. This opens a confirmation dialog. In the dialog, type DELETE SECRET in the text field to confirm deletion of the credentials.