Manage API Keys
API keys enable you to work with Emporix API with different scopes and perspectives.
The Manage API Keys view of the Emporix Developer Portal is the place where you access the API keys connected to your tenants. API keys allow you to access API from either business or a customer's perspectives.
When you create an Emporix tenant, you obtain keys to the following types of :
Used to access and manage your tenant's resources. With this key, you have access to all services and scopes within the application.
Storefront API
Used to access storefront application to perform basic e-commerce actions like browsing products, viewing prices, or adding products to cart.
Custom API
Used to define your own keys for separate services and with specific scopes.
To authorize API requests, you need Client ID and Secret of a specific API key depending on the request you want to send. You can easily copy the credentials with the copy icon or view the Secret with the preview icon. Also, it is possible to regenerate the API keys by choosing the renew option.
Custom API keys
You can create your custom API keys for various purposes. It is possible to define separate API keys for different services that contain some specific scopes. This way the application stays more secure. The custom API keys are assigned to the specific tenant.
Creating custom API keys
If you don't have any custom API keys, in the Manage API Keys view choose the Create scopes in the Custom API row. Once you have already defined some API keys and want to define more scopes, expand the Custom API and choose Add custom API.
Enter the name for your custom keys and select the scopes of your interest. You can choose scopes from different services.
Confirm with Generate and the created group appears under Custom API.
Quick start sample
For easier start of working with API keys, you get a preview of sample requests. Choose the Get started option next to the selected API key to get a preview of an example request.
Last updated
Was this helpful?