The availability of features may depend on your plan type. Contact your Customer Success Manager if you have any questions.

Dev GuideAPI ReferenceUser Guide
Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideLegal TermsGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
Dev Guide
Legal TermsGitHubDev CommunityOptimizely AcademySubmit a ticket

Become a technology partner with Optimizely

Describes how to become a Technology Partner with Optimizely to help support your integration.

Suggest Edits

📘

Note

See Optimizely's Third-Party Add-Ons & Platform Integration Terms.

If you want to partner with Optimizely to help support your application (app, sometimes called add-on or integration), you should apply to the Technology Partner Program. Becoming a partner provides many benefits, including hands-on developer support and marketing benefits to help promote your integration to Optimizely Web Experimentation customers.

Log in to your Optimizely account

Log in at https://app.optimizely.com/v2.

Apply to the Technology Partner Program

Fill out the Technology Partner Program form to apply. You should apply for the program before you start developing an integration so that we can provide you with appropriate guidance using the Optimizely APIs and plan for launch.

Register your app

We require all Technology Partners to formally register their integration with Optimizely so we can better track which APIs are most important to our partners. Registering your app is easy. If your integration is using the REST API, we require you to use OAuth 2.0 authentication and register your integration as an OAuth client. If your integration is using the JavaScript API, we also require you to make a one-line API call. The steps to register your integration are described in the Register your integration section.

Build your app

There are many ways to integrate with Optimizely, depending on your needs. To decide how to best integrate with our platform, review the chart of Integration Types below, which includes some common types of integrations built by customers and partners. Each integration type includes a step-by-step guide including example code that you can use to build the integration. If none of these integration types meet your needs, see REST API documentation.

Submit app for testing

Our team is eager to provide feedback and make sure the integration works as expected. Go through the Integration Checklist before submitting your app to [email protected] to make the review process as quick and smooth as possible. You can find the checklist in the App Checklist section.

Promote your app

After Optimizely has tested and approved your app, you can work with your Partner Manager to get your app listed in the Technology Partner Directory. As a Technology Partner, you also receive a Marketing Playbook that provides detailed guidance on promoting your app to Optimizely customers.

If you have questions about becoming an Optimizely Technology Partner, email [email protected].

App checklist

Optimizely reviews apps submitted to [email protected].

This guide should help your app go through the review process quickly. This guide does not replace or supersede the Developer Policy, which must be adhered to at all times.

Test details

Sandbox account

Set up a working account that can be used by Optimizely employees to do functional testing.

Instructions

Provide high-level testing instructions for an Optimizely employee to test your app. During the test process, our engineers check the expected behavior. We aim to partner with great products, so we also expect to not encounter serious bugs in the product during QA.

Listing

Appropriate name

Your app's name should not infringe upon a trademark or copyright for any other products or services. Also, if you have any, remove any reference to Optimizely in the app name. For integration, you should use your product name or a combination of your company name and your product name. Examples:

  • Your company name is XYZ and your product name is Product: XYZ Product
  • Your company name (XYZ) is the same as your product: XYZ

Logos

Optimizely needs two versions of your logo:

Follow these guidelines when you create an integration of an application logo that will appear in Optimizely.

Design the logo

  • Avoid putting an edge or border around the image.
  • Avoid drop shadows if possible. It is OK to use small shadows for contrast.
  • Make the logo face the screen. Do not put perspective on it.
  • Logo should be visible on both white and light gray backgrounds.
  • Logo should be square with no rounded edges.
  • Logo should be a PNG file.

Optimizely logos

  • Do not use the Optimizely logo (original or modified) in any logo.
  • Do not use any icons or logos that can be found in the Optimizely app, as this could confuse users.

Logo for apps and integrations dashboard

  • Logo should be exactly 200 × 200 px.

Logo for partner directory

  • Minimum size for the logo: 280 × 80 px
  • Maximum size for the logo: 500 × 160 px

Installation link

This is how customers install your app, so it's important to make it as easy as possible. It should contain:

  • Information about your services
  • Information about how the integration interacts with Optimizely

Customer support link

As part of your submission to the Directory, you agree to "keep your app updated and your support channel active", so please ensure that the link you provide is to an active and responsive support channel.

Customer support email

Please make sure this is an email address that you check regularly and is clearly connected to your app.

Registering your app

Make sure your app activity is visible to Optimizely. Go through the steps described here.

Submit all information

Use all the information from above to fill in this form.

Registration

Optimizely requires all partners that have an app to register an OAuth 2.0 client. Using OAuth 2.0 provides the following benefits:

  • We can better support your app and our mutual customers.
  • It allows us to better understand which functionality has made the biggest impact on the customer experience.
  • It helps us determine where to invest more time for improvements.
  • For apps that use the REST API, OAuth 2.0 provides a better, more transparent customer experience.

If your app doesn't use the REST API, creating an OAuth 2.0 client is still a required step.

If you have questions about registering your app, email [email protected].

The following steps describe how to register an OAuth 2.0 client.

1. Create an OAuth 2.0 client for your integration

Sign in to the account and go to https://app.optimizely.com/v2/accountsettings/registered-apps.

Click Register New Application.

Fill in the fields with the following values:

  • Application Name – the name of your integration
  • Redirect URI – your homepage
  • Client Type – can be Public or Confidential, depending on your application. If your integration only uses the JavaScript API, use "Public". The client type for a REST API app depends on your setup. See Grant types.

Click Apply.

2. Implement API-specific requirements

Apps that use the REST API

We require every app that uses the REST API to authenticate with the OAuth 2.0 client that you created in the previous step. See Get started with OAuth 2.0 documentation.

Apps that use the JavaScript API

If your app is using the JavaScript API, we also require you to make a one-line API call at the top of your app's JavaScript:

window.optimizely = window.optimizely || [];
window.optimizely.push({
 'type': 'integration',
 'OAuthClientId': 5352110138 // This is the OAuth Client ID you've copied in the previous step.
});

The client ID used in the one-line API call can be found here:

Updated 4 months ago