The OAuth 2.0 Testing API enables users to validate data retrieval using
standard OAuth 2.0 authentication with refresh token support.
This API demonstrates how OAuth 2.0 secured endpoints can be integrated with eZintegrations.
This API is intended for testing and validation purposes when configuring
OAuth 2.0 based source systems in eZintegrations.
Overview
The OAuth 2.0 Testing API is a sample endpoint provided by eZintegrations to demonstrate
OAuth 2.0 authentication flows, including access token generation and refresh token handling.
When to Use This API
This API is typically used when configuring OAuth 2.0 based integrations in eZintegrations to:
- Validate OAuth 2.0 authentication and access token generation
- Test refresh token handling during access token expiration
- Verify secure access to OAuth 2.0 protected endpoints
- Troubleshoot authentication or token-related issues before production deployment
API Details
Method
GET
Endpoint
{{base_url}}/partner/orderdetails-OAuth2.0
This endpoint returns sample order details protected by OAuth 2.0 authentication.
Authentication
Authentication Type
OAuth 2.0
The OAuth 2.0 Testing API uses OAuth 2.0 authentication. Access tokens and refresh tokens
are generated using the OAuth 2.0 token endpoint and are required for all API requests.
Refresh Token Endpoint Method:
POST
Token Endpoint
{{base_url}}/partner/api/oauth2/token
OAuth 2.0 Token Configuration
Request Headers
{
"Content-Type": "application/x-www-form-urlencoded"
}
Request Body
{
"grant_type": "password",
"client_id": "{{client_id}}",
"client_secret": "{{client_secret}}",
"username": "[email protected]",
"password": "B!zdata@360"
}
This configuration is used by eZintegrations to generate access tokens and refresh tokens.
Token refresh is handled automatically by the platform when access tokens expire.
Numeric Parameters
| Parameter | Value | Description |
|---|---|---|
| Minimum Number | 0 | Minimum records per request |
| Maximum Number | 1000 | Maximum records per request |
How to Retrieve Data Using OAuth 2.0 in eZintegrations
- Retrieve the Base URL from the My Profile section in your eZintegrations account.
- Configure the OAuth 2.0 Testing API as a source system within eZintegrations.
- Provide the required OAuth 2.0 credentials, including client ID and client secret.
- Configure the OAuth 2.0 token endpoint and grant details during source setup.
- eZintegrations automatically generates, refreshes, and manages OAuth 2.0 access tokens.
- Execute the integration to retrieve data securely, with authentication handled internally by eZintegrations.
This approach allows users to retrieve data without manually generating or refreshing OAuth tokens.
Frequently Asked Questions
1. What is the purpose of the OAuth 2.0 Testing API?
The API is used to test OAuth 2.0 authentication and refresh token handling when configuring OAuth 2.0 based integrations in eZintegrations.
2. Does this API support refresh tokens?
Yes. The API demonstrates OAuth 2.0 authentication with refresh token support.
3. Are pagination parameters required for this API?
No. Pagination is not applicable for this API.
4. Where can I obtain the Base URL and OAuth credentials?
They can be generated from the My Profile section in your eZintegrations account.
Notes
- OAuth 2.0 authentication is mandatory for all requests
- No pagination is implemented for this endpoint
- Authentication and token refresh are handled internally by eZintegrations
- This API is intended for testing and validation purposes only
