Studio API Resource Guide for Service Providers

This supplementary guide to the Studio API Resource Guide is intended for a service provider audience.

API Headers for Service Providers

Service providers can access the ac or sp scope.

Header

Description
Scope

Select ac to access Studio as an account holder. Select sp to access Studio as a service provider.
Scope Id

Where the scope is ac, supply the Studio account Id. If you don't know the Studio account Id, log in to the Studio interface, navigate to the account, and navigate to Studio Manage | Account Profile.

Where the scope is sp, supply your service provider Id. If you don't know your service provider Id, log in to the Studio interface and navigate to Studio Manage | Service Provider Profile.
Studio API Key

Supply a Studio API key generated for the given scope Id. You will see an error if the Studio API key and Scope Id don't match.

Follow these steps to generate a Studio API key.

  1. Open Studio Manage | API Keys.

  2. For ac scope, select the Studio account.

  3. Assign permissions to the key in line with the actions you want it to perform.

See Studio Manage |API Keys.
Note:

If an API key is compromised, delete the key to prevent misuse.

Studio API Keys for Service Providers

Follow the instructions at Studio Manage | API Keys with the following supplementary detail.

Parameter Description

Account

If you are a service provider generating an API key for a Studio account, select that Studio account. The API key will only work with that Studio account.

Click All Accounts to generate an API key to work with all studio accounts in your purview and a key with sp scope.