Setup & Authentication
To begin using the Osigu Payments API, you must set up authentication to secure access to API endpoints. Osigu Payments uses OAuth 2.0 with the client credentials grant type for secure, machine-to-machine communication. Here’s a high-level overview of how the authentication flow works and integrates with your setup process.
Authentication Flow
-
Obtain Access Token:
The first step in authenticating with the Osigu Payments API is to request an access token. This is done by sending your client ID and client secret in a secure, Base64-encoded format to the token endpoint. This exchange returns an access token, which is your key to access the API. -
Include Access Token in Requests:
Once you have an access token, it must be included in theAuthorization
header for every API request to Osigu Payments. This ensures all communications are authenticated, and the token remains valid for 24 hours. -
Token Renewal:
Tokens are time-limited and expire after 24 hours. When a token expires, you must request a new one by repeating the token request process. This cycle ensures that tokens remain secure while allowing uninterrupted access.
Quick Setup Steps
- Step 1: Ensure you have your client ID and client secret. If you don’t have these credentials yet, please get in touch with your Customer Success agent to receive this information. They will assist you with the setup process within our platform and coordinate integration support with our Integrations Team.
- Step 2: Make a POST request to the OAuth token endpoint to receive your access token.
- Step 3: Use the access token in the
Authorization
header asBearer <access_token>
for all API interactions.
For detailed examples and code samples, see the API Reference's Authentication section.
Updated 24 days ago