The API Essentials section provides critical information and configurations needed for seamless integration with the Osigu API. This section covers core topics, including environments, error handling, pagination, date formats, currency codes, country codes, and authentication, which are applicable across all endpoints and functionalities within the API.
What You’ll Find Here:
- Environments: Details on the sandbox and production environments, including base URLs and specific differences between them.
- Error Handling: Explanation of standard error codes, error structures, and best practices for managing errors within API responses.
- Pagination: Guidelines on managing large data sets with pagination, including default page sizes and configurable options.
- Date Formats: Standard date and time formats (e.g., ISO 8601) used throughout the API to ensure consistency in date handling.
- Currency and Amounts: Information on supported currency codes (ISO 4217) and how amounts should be represented in the API requests and responses.
- Country Codes: List of supported country codes, allowing accurate identification of payers and providers within the platform.
- Authentication: Overview of the OAuth 2.0 client credentials authentication process required for secure access to the API endpoints.
This section is designed to help developers understand the global standards and settings within the Osigu API, providing essential knowledge for successful integration.