Overview
Obtaining API Keys
To obtain a Rewarble client API key, you must first meet the following requirements:
- You must have a working Rewarble account
- Your Rewarble account must have accumulated at least 500 EUR in total deposits over its lifetime.
To create an API key, please visit the Rewarble Client API page.
Authentication
The API uses Bearer token authentication. Include your API key in the Authorization header with all requests.
Authorization: Bearer <api key>
Error Handling
Error Codes
| Http status code | Https status | Description |
|---|---|---|
| 400 | bad_request | Invalid request |
| 401 | unauthorized | Missing or invalid API key |
| 402 | payment_required | insufficient balance |
| 403 | forbidden | IP not whitelisted |
| 404 | not_found | Item not found |
| 429 | rate_limit_exceeded | Too many requests |
| 500 | server_error | Internal server error |
Whitelist
Restrict API access to designated IP addresses. The following configurations are supported:
- Single IP Address:
192.168.1.1 - Multiple IP Addresses:
192.168.1.1,192.168.1.2 - CIDR Range:
192.168.1.0/24(encompasses192.168.1.0to192.168.1.255)
Leave the field empty to permit access from any IP address. Use commas to delineate multiple entries. Only IPv4 addresses are supported.
URL
Rewarble API urls adhere to the following structure:
{BASE_URL}/client/{VERSION}/{RESOURCE}
Base url:
https://api.rewarble.com
Current version:
1.00
Examples:
https://api.rewarble.com/client/1.00/redeem
https://api.rewarble.com/client/1.00/payout
Rate Limits
The maximum number of requests is based on your volume of the previous day around the same hour. There is a buffer in place that assures new users do not get rate limited straight away.
The number of requests are based on every request made by your account, IP or API key.