Use client credential keys to identify and authorize your integration on Sonos.
Company/Organization administrators and members
When you first sign up to the developer portal, if you are the first in your company or organization to sign up, you’re added as the administrator of your company. Administrators can:
- Invite other users to collaborate.
- Promote users to administrators.
- Remove users.
- Create integrations and client credentials.
If you’re a user in a company or organization, you can view the list of other users, but you can’t invite other users or manage users. You can also view integrations and client credentials, but you can’t create or manage them.
Invite others to collaborate
As an administrator, you can invite others from your company to join the site to collaborate on your Sonos integration.
To invite users:
- Click My Account in the top-right of the screen and choose Users.
- Enter an email address and click Send invite.
The user will receive an email invitation with a link to sign up. Once they sign up they’ll be able to see you in the Users list and you’ll be able to see them.
To manage users:
- Select the check box in the Admin? column to promote them to an administrator.
- Click Remove to remove a user. Users can remove themselves as well.
Note: You can’t invite users that are already on the developer portal as part of another group.
Create an integration
As an administrator, you can also create an integration.
To create an integration:
- Click My Account at the top-right of the page.
- Click Integrations.
- Click New control integration.
- Fill out the fields described below. To make changes, edit the field and click Save to save changes.
To delete an integration, click Delete.
Note: Fields are required unless marked optional.
Display name and description
Enter a display name and description for your integration.
|Display name…||Enter a name for your integration. Sonos displays this name to users in the Sonos login service, when asking if they want to give permission to your integration.|
|Briefly describe your integration||Provide a brief description of your integration to help us understand what you will be providing to users and how it will work.|
Create your client credentials.
|Key name||Enter a name for your client credential key. This can be the name of your product, product family, or SKU. You may also want to use the key name to differentiate between different environments or locales. For example, you may have one key for your test environment and one key for your production environment.|
|Key||The client credentials key generated by Sonos.|
|Secret||The client credentials secret generated by Sonos.|
|Redirect URIs||Enter redirect URLs so the Sonos login service can send the user back to your client with an authorization code. You can enter multiple redirect URLs. The redirect URL in your authorization API call must match one of the redirect URLs that you provide here. See Authorize and Authorization API for details.|
|Event Callback URL||(Optional) Enter an endpoint that Sonos can use to send events. You can only enter one. See Subscribe for details.|
The Operations tab provides the opportunity to supply information about your company to help Sonos better support our customers when your integration goes live. You are welcome to fill this information out now, but it is not required to begin development.