Developer Portal overview

10 min

The Developer Portal gives Optimizely Connect Platform (OCP) developers a user interface (UI) to register apps, generate and manage API keys, and view app versions and their installations. Use it to build custom integrations that connect external systems to OCP or Optimizely Data Platform (ODP), or to retrieve the credentials your OCP command-line interface (CLI) needs to publish an app.

Access the Developer Portal

To access the Developer Portal, you need the Developer role in the Admin Center of your organization. Follow these steps to get access:

Contact Optimizely Support to request developer access for your organization. Optimizely must enable developer access before the Developer role becomes available in the Admin Center.

After Optimizely Support enables developer access, the Developer role displays in the Admin Center.

Assign the Developer role in the Admin Center. This role is required to access Developer Portal. See Assign Developer role.

Assign Developer role

If you are already an admin in your organization, you can assign the Developer role to yourself. Complete the following steps:

Go to the top navigation bar and select your organization > Admin Center from the drop-down list.

Click Invite User > Invite Users Manually.

Enter your Email ID. Optimizely automatically populates the First Name and Last Name based on your email ID. Click Continue.

Click Add Product Access. Under Access, select Connect Platform and your Instance from the drop-down list. Select the Developer role from the Role drop-down list and click Continue.

Review your invitation and click Send. The invitation is sent to your email.

The Developer Portal displays in the navigation menu for any OCP account where you hold the Developer role.

Note

If an administrator removes your Developer role from all OCP instances in an organization, you lose access to Developer Portal, and your API key for that organization stops working.

Developer accounts and organizations

There are two separate levels of access for an OCP partner organization and their customer organization:

For developing and managing apps – Your organization must have developer access enabled, and an administrator in your organization must give you a Developer role. When you have it, you can generate an API key and build, publish, and manage your apps.

For installing and managing apps – Your customer's organization does not need developer access, and they do not need to give you or anyone from their own organization a Developer role. They can assign any role to you for a Connect Platform instance from their organization's Admin Center. After you get access, you can develop apps on your own organization (that has developer access) and install the apps on your customer's organization.

If you have access to multiple instances, switching your instance does not affect your developer role or your API key. Developer roles are assigned per organization, and each developer generates their own personal API keys for that organization. See Manage your API key.

Register an app

To register a new app in the Developer Portal, complete the following steps:

Enter a unique App ID. The app ID must use lowercase letters, numbers, and underscores, start with a letter, and be three to 32 characters long.

Enter your App display name. The target product determines which Optimizely product your app extends.

Select the target product for your app:

For OCP – Extends Optimizely Connect Platform. Use this option to pull external data into Optimizely products or add tools to Optimizely Opal.

For ODP – Extends Optimizely Data Platform. Use this option to sync customer data into ODP or send campaign data out to marketing platforms.

Select Register app to complete registration. OCP shares a registered app with every developer in your organization by default.

View app versions and installations

To view a registered app's versions and installations, complete the following steps:

Click your app in the Apps list.

Go to the Versions tab to view every version of the app with its region and status. Toggle Show unpublished on to view unpublished apps.

BUILT – The version is built but not published.

PUBLISHED – The version is published and available to install.

UNPUBLISHED – The version is unpublished.

Go to the Installations tab to view the list of the OCP instances where the app is installed, along with the installed version, region, installation date, and last-updated date. The tracker ID for an instance displays partially masked when you do not have a role on that instance. The masked ID confirms the app is installed there without revealing the full tracker ID.

Manage your API key

You can generate and manage API keys for your developer account through the Developer Portal. A developer account is scoped to a single organization, and each developer account has its own API key. If you have Developer roles in multiple organizations, you must generate API keys for each organization.

Note

You do not need multiple API keys to develop, manage, and install apps on a customer organization's OCP instance. You can generate an API key for your own organization and use that key to install apps on your customer's instance, as long as you are assigned any role for that instance. See Developer accounts and organizations.

Generate API key

Generate your API key to let the OCP CLI authenticate:

Go to API Key and click Generate API key. A prompt displays your API key. The full key only displays once at generation. Copy it and store it securely.

Click Done.

View your active key status and copy the commands that save it to your OCP credentials file:

Regenerate your API key

Important

Regenerating your API key revokes the current key immediately. Any OCP CLI session or pipeline using the old key fails with a 401 Unauthorized error until you update it with the new key.

To regenerate your API key, complete the following steps:

Go to API Key and click Regenerate API Key.

Select Confirm.

Update your OCP credentials file with the new key.