Graph development accounts and developer instances in Search Management portal
Beta Search Management portal is in beta. Access this feature when you have the following:
- Opti ID
- Optimizely Graph instance access
Development accounts give developers an isolated development environment, also called a sandbox or test environment, to test Optimizely Graph without affecting production systems. When you create a development account, Optimizely provisions a development instance, which is a separate Graph instance with its own credentials. If you are looking for a Graph developer index, sandbox, or dev environment, this is the feature to use.
This feature is available to existing Optimizely Graph customers who need an additional development instance. To create a development instance, validate queries, prototype an integration, or explore features before you deploy to production, use the Search Management portal. If you are new to Optimizely Graph and want to evaluate it, see Request an Optimizely Graph developer instance for CMS 13.
Development account limits
Development accounts support evaluation and non-production use only. They have the following limits:
- Expiration – Each account expires 90 days after creation.
- Query throughput – Each account supports up to 50 queries per second.
Create a Graph development instance
Complete the following steps to provision a development instance, or Graph developer index, in the Search Management portal. To open the portal, see Access the Search Management portal.
- Under Developer, click Development Accounts.
- Complete the following required fields:
- Developer First Name – Enter the first name of the developer who uses the instance.
- Developer Last Name – Enter the last name of the developer who uses the instance.
- Developer Email – Enter the email address that receives administrator access to the instance.
- Region – Select the region that hosts the instance.
- Click Create Developer Instance. The Provisioning Instance window opens.
- Stay on the page while Optimizely provisions the instance, which takes a few minutes.
- When provisioning finishes, the page displays the following credentials:
- Instance Name – The display name of the development instance.
- Instance ID – The unique identifier of the instance.
- Portal URL – The endpoint URL for the instance.
- AppKey – The application key that identifies the instance in API requests.
- Secret – The secret key paired with the AppKey to authorize requests.
- Single key – The read-only key for client-side query requests.
Optimizely provisions the instance and grants administrator access to the developer email you entered.
Warning The page displays these credentials only once. After you close the page, you cannot retrieve them. Copy and store them in a secure location before you leave the page.
Best practices for development accounts
Follow these practices to get the most from a development account:
- Enter an accurate email – Confirm the developer email is correct so administrator access reaches the right person.
- Match the region to your team – Select the region closest to your team to reduce latency.
- Use non-production data only – Never load production data into a development instance.
Frequently asked questions
How do I create a Graph developer index?
Create a development account in the Search Management portal. Optimizely provisions a development instance that you can use to index and query test content. See Create a Graph development instance for the steps.
How do I create a Graph development environment?
If you are an existing Optimizely Graph customer, create a development instance in the Search Management portal by following Create a Graph development instance. If you are new to Optimizely Graph, request a developer instance by following Request an Optimizely Graph developer instance for CMS 13.
Is a development account the same as a Graph instance?
Not exactly. A development account is the Search Management portal feature you use to create a development instance. The development instance is a Graph instance for non-production use. It has its own instance ID, endpoint URL, and credentials, expires 90 days after creation, and supports up to 50 queries per second. Your production Graph instance remains separate.
What credentials do I get with a development instance?
Provisioning returns an AppKey, a Secret, and a Single key. See Authentication to choose how to use them.