Data Fetch API
This API allows operator developers to fetch/pull information from our platform to facilitate synchronization with your platform or external platforms, such as CRMs, to fetch data generated within the Gamanza Engage environment. You can retrieve information about ranks, levels, reward shops, missions, tournaments, and more.
Authentication
To access the API, you'll need to authenticate using OAuth client credentials that you can create in our Admin UI under the system settings section. Please check out these docs for more details: Authentication with Platform API
Considerations
Syncing Data with Delta Values
To efficiently sync data, the API supports a delta parameter. This parameter allows you to fetch only the elements that have changed since the last sync. If the delta parameter is not provided, the API will return all elements from the beginning.
Pagination and Item Limits
- The maximum number of items returned per API call is 1000.
- You can adjust the limit to a smaller value using the limit parameter.
Limitations
Rate Limiting
To ensure the stability and reliability of our API, we enforce rate limiting. The rate limit for the Data Fetch API is 100 requests per minute.
How Rate Limiting Works
- Rate Limit Window: A sliding window of one minute.
- Maximum Requests: 100 requests can be made within this window.
- Throttle Behavior: If the limit is exceeded, further requests will be blocked until the window resets.
Please review our Integration Best Practices for more details.
Now, please take a look to our Data Fetch API Reference. Happy integration and happy coding!
