OAuth 2.0
Optimizely Web Experimentation provides the OAuth 2.0 protocol to let you authorize third-party applications to access your data with the REST API. It lets you grant access to an application without sharing your Optimizely username and password. View and revoke applications you have authorized in your account settings.
Optimizely's REST API lets you create and manage Optimizely Web Experimentation projects and experiments and analyze results from other applications. For example, Optimizely's solutions partners and technology partners use the REST API to
- A/B test headlines from within WordPress.
- Create audiences based on information collected from your Data Management Platform.
- Manage projects from an internal system.
- Pull results data into an internal dashboard or results widget.
- Send email alerts when certain results are achieved.
Applications that are built on the REST API (such as technology integrations) can use OAuth to access data on the customer's behalf by putting them through an authorization flow (similar to how you can log into many accounts using your Facebook or Google login).
Authorize applications
You can grant trusted third-party applications access to your Optimizely account by logging in through a Connect with Optimizely button.
View authorized applications
You can see a list of third-party applications that you have authorized to access your Optimizely data by going to Account Settings > Registered Apps in Optimizely Experimentation.
Revoke permissions
To unauthorize a third-party application at any time, revoke it from this menu by clicking Revoke Access and confirming your decision. When you revoke permissions, you cannot authorize or re-authorize third-party applications from this menu. To do that, you must go back to the app you want to authorize and go through the authorization process again.
Register applications to use OAuth
To build integrations using Optimizely Web Experimentation's REST API, reference the Optimizely API documentation, which covers the endpoints and calls you can use.
If you want to register an application to access the API with OAuth, complete the following steps:
- Go to Account Settings > Registered Apps.
- Click Register New Application.
- Enter the Application Name and Redirect URI and select a Client Type (Public or Confidential) in the Application Settings window.
- Click Apply.
Build an OAuth 2.0 flow into your application
To build an OAuth 2.0 flow in your application, complete the following steps:
- Decide which Grant Type is most appropriate for your application.
- Register your application with Optimizely.
- Point customers to Optimizely's authorization URL in your application.
- Process a redirect after the user accepts (or rejects) your application's access.
- Obtain an access token using an authorization code or refresh token, or through the redirect itself, depending on the authorization flow you are using.
- Authenticate with the REST API using the provided access token.
The sections in this category walk through each of these steps in detail.
If at any point you have questions or need help building out an OAuth 2.0 flow, submit a ticket to the developer support team.
