Submit your service

Sonos provides a wizard-like version manager tool to submit your content service to Sonos. Sonos then reviews and validates your service integration. After it passes review, Sonos works with you to release your service onto the Sonos network.

After you've begun to build and test your service, use the version manager tool to fill out a series of forms with details about your service. Completing a submission can take a significant amount of time, especially for the first version. The version manager enables you to save your progress.

After submission, your service goes through the following additional phases to reach general availability for all Sonos users.

---

Add your service to Sonos

To add your service to Sonos, start logging into the Developer Portal. You must be a registered partner and logged into the Developer Portal site to access the integrations version manager.

Add a new submission

Add your service integration submission in the Developer Dashboard.

If this is your first submission:

1. While on developer.sonos.com, select Dashboard in the top navigation. This will bring you to your Integrations page.
2. Click the + New Content Integration button. This will open a separate window.
3. Under the Content Integration (Sandbox) option, click Create Integration.
4. Fill out the integration form.

Convert your integration

If you are converting a Content Integration submission from an existing Sandbox submission:

1. On your Integrations page, find your sandbox submission and click the Manage button. This will take you into the Content Integration Form.
2. Select the Convert to Production button at the top-right of the form. This will open a new window with two options.

To create a new, standalone Production form:

• Select Create a new integration and click Ok. This will navigate you to a new screen.

To replace a live Production form with a newly-created Production form:

• Select Replace an existing integration and click Ok. This will navigate you to a new screen.
• Select the live Production integration you want to replace.

3. Fill out the Configuration Label field. This will allow you to differentiate between the older Production version from the newer version.
4. Click Duplicate. This will generate the new Production form and navigate you into the newly-created form.
5. Review the Production Integration form in its entirety, providing additional details where required.
6. When you have completed the new form, click the Submit button in the top-right corner.

📘

You can save your form and resume filling out details at any time.

---

Fill out the version manager form

The version manager form consists of multiple sections, listed below:

• General Information
• Sonos Music API
• Brand Assets
• Localization Resources
• Image Replacement Rules
• Browse Options
• Search Capabilities
• Content Actions
• ICS Settings
• Service Configuration
• Object Storage

Submit for validation

When you have completed entering the information, submit your form to start the next phase.

🚧

Before you submit...

• Be sure that you have completed all required fields on your submission's pages.
• Ensure your supplied graphics and other assets follow all guidelines.
• Inform your Solutions Architect that your submission is ready for review.

---

Application review and validation

After you submit your service integration, Sonos works with you to:

1. Create a Basecamp account to work with you and share the status of your submission.
2. Confirm all your submission's entries.
3. Test your music service.
4. Review branding and user-facing items such as logos.
5. Ensure that your submission includes all the required information. Sometimes we have to reject your submission so you can make changes and resubmit it.
6. Perform a series of manual tests of your service integration after accepting your submission.

Sonos confirms your submission

We confirm that we can access these items. These include:

• All logos and UI items.
• The QA support accounts.
• The customer care accounts.

Sonos reviews your branding

While we are reviewing your submission for development issues, we also consider your branding. We review the items on the technical configuration and test setup and marketing and other general questions sections.

We review the logos, icons, and UI text strings in your service integration. For example, we check the lengths of the text strings and URLs to ensure that they fit the displays in the Sonos app. We also review your marketing information for inclusion on Sonos websites. For example, we list all services in the streaming services section of the Sonos website.

We review the co-branding page where customers sign-up for your service. This review ensures that your service looks consistent in Sonos apps and your app and websites. When Sonos users add your service in the Sonos app, the app loads this web page so users can login or get a new account. This effort isn't necessary if your service allows anonymous users who do not have to log in.

Sonos offers a discount package for your employees to get Sonos products. We ask for employee info on the application in order to provide this discount.

Sonos creates a frequently asked questions (FAQs) page about your service on the Sonos support site. For some examples see:

• Deezer and Sonos
• Spotify and Sonos

Sonos approves or rejects your submission

If we reject your submission, we'll explain the reasons in Basecamp so you can update and resubmit it. Once we've accepted your submission, we'll perform manual testing.

Sonos performs manual testing

Sonos runs a series of manual tests of your service integration and sends you a summary. If some manual tests don't pass, you must fix the issues found in your integration. Then you must resubmit your application so that we can run the manual tests again. This process continues until your integration is ready for preview.

During the manual testing process, Sonos may also prepare for your preview. If you are an existing partner and your submission is an update, you may not need a preview. We'll work with you to determine this on a case by case basis.

---

Preview release

Preview allows you to perform load testing and fine-tune your service. During the preview, Sonos customers can test your service and submit bugs. We'll work with you to set a preview launch date and coordinate with you to make it available to customers. The length of your preview depends on the complexity of your implementation. It can last eight weeks or more.

If you are an existing Sonos partner, Sonos decides if you need another preview cycle. Some examples of changes that may need another preview cycle include:

• Significant changes such as an entire integration re-work.
• Addition of a large number of new features or capabilities.
• An earlier integration was particularly difficult.

Sonos will continue to communicate with you through basecamp during the preview. You should ensure that your service maintains the standards described in your service level agreement (SLA). See the Sonos Escalation Process document linked below for a sample SLA.

📘

See the Sonos Escalation Process (PDF) form on Sonos Labs for a sample SLA between Sonos and your service.

When your service is in preview, Sonos adds an icon to your service logo to show that your service is in preview. Users can also view all services in preview with the preview filter. The preview icon disappears after a user adds your service. Your service will only be available for testing by users who enable Sonos to see their usage data. See the Settings section of the Sonos User Guide for details.

Exiting the preview program is at Sonos’s discretion and is based on meeting error and usage rates. Sonos will coordinate with you to ensure these rates are adequate. Some factors that play a part in this decision are:

• Service Performance
• Feedback
• Resolution of open issues

---

General Availability (GA) release

After a successful preview, Sonos will release your service for general availability (GA). This can occur as soon as 8 weeks after your preview. Sonos will work with you to set a GA date and coordinate with you on your Basecamp account. The following key actions occur when we release your service for GA:

• Your music service appears on the Sonos Music Menu with the preview icon removed from your logo.
• Sonos coordinates with you to ensure all web assets are up to date and posts your logo to the streaming services section of the Sonos website.
• Sonos coordinates with you for updates and then publishes your FAQ on the Sonos support site.
• Sonos changes the name of your Basecamp account to GA: Your-Service-Name

---

Upgrades and changes

👍

Upgrade tips

• If you are upgrading your service integration, start with a copy of an existing submission.
• Please send us a note on Basecamp to describe what you're changing and the customer-facing impact of the change.

Upgrades and changes to your integration require a new submission version. These should take less time than your first one as you can start from a copy of a previous submission. Fill out a new version whenever you make a change, such as when you:

• Add new regions.
• Add a new description for your service.
• Change your service name.
• Add new features or capabilities.
• Update logos, string text, and web assets.

Some updates may not need a full validation phase or preview release. For example, new global regions, logos, service descriptions, or name changes. If you need to take your service offline or remove an integration, email Sonos at [email protected].