How can I generate API credentials?
0 people liked this article
To connect to expereoOne API V2, API credentials must be generated via the Developer Portal V2. These credentials are required to authenticate and obtain access tokens using OAuth 2.0.
Prerequisites
Before generating API credentials, ensure you have:
- An active expereoOne user account
- Access to Developer Portal (API) permissions
Steps to Generate API Credentials
- Log in to expereoOne
- Navigate to Developer Portal V2
- Go to the API tab
- Locate the APIClients resource
- Use the POST /api-clients endpoint to create a new API client
Example Requests
Example 1: Basic Scope
{ "apiClientName": "ScopeName1", "scopes": [ “BasicRead” ] }
Example 2: Extended Scopes
{ "apiClientName": "ScopeName2", "scopes": [ "BasicRead", "SupportRead", “SupportReadWrite” ] }
Available Scopes
| Scope | Description |
| BasicRead | Read-only access to core resources |
| SupportRead | Read access to support/case data |
| SupportReadWrite | Read and write access to support/case data |
| BillingRead | Read access to billing and invoice data |
Note: Scopes determine access boundaries and cannot be modified after creation. To change scopes, a new API client must be generated.
What Happens Next?
After creating your API client:
- You will receive:
- Client ID
- Client Secret
- Use these credentials to request an access token via OAuth 2.0 (Client Credentials Flow)
- Include the token in API requests for authentication
Best Practices
- Store your Client Secret securely (it is sensitive and should never be exposed)
- Create separate API clients for different use cases or environments (e.g., sandbox vs production)
- Use the minimum required scopes to follow the principle of least privilege
Helpful Links
Popular Articles
-
What is the Support process for managing and handling cases?
3 people say this guide was helpful
-
Where can I find the Reason for Outage (RFO) for an Incident Cases?
1 people say this guide was helpful
-
How to create a new case in expereoOne?
16 people say this guide was helpful
-
How to Add a New User in expereoOne?
1 people say this guide was helpful