ℹ️API Overview

Integrate Bounce API with backend, frontend and applications

API Usage

Authentication

API Tokens

The Bounce API uses personal access tokens to authenticate requests. You can view and manage your access tokens in the Developer Settings of your Bounce user account.

API requests are authenticated using the Bearer Auth scheme. To authenticate a request, provide the token in the Authorization header of the request:

curl -H "Authorization: Bearer <your_access_token>" https://api.letsbounce.gg/v1/<endpoint>

Access tokens are tied to the Bounce user account for which they were created. A token provides the same level of access & privileges that its associated Bounce user account would have.

Please be sure to keep your API access tokens secure!

Do not share them in emails, chat messages, client-side code or publicly accessible sites.

If you have accidentally shared an API access token publicly, you can revoke it in the Developer Settings of your Bounce user account.

Trusted origins

For API endpoints that can be called without an authentication token, such as from frontend applications, a list of trusted origins can be provided to limit the risk of unauthorized access. A public key must still be provided for billing, tracking and rate limiting purposes.

Rate limiting

Different types of API methods are subject to different rate limits.

The response's HTTP headers are the authoritative source for the current number of API calls available to you or your app at any given time. The returned HTTP headers of any API request show your current rate limit status, as described below.

Header Name	Description
X-RateLimit-Limit	The maximum number of requests you're permitted to make in the current rate limit window.
X-RateLimit-Remaining	The number of requests remaining in the current rate limit window.
X-RateLimit-Reset	The time at which the current rate limit window resets in UTC epoch seconds.

If you exceed the rate limit, an API error response is returned:

> HTTP/2 429
> X-RateLimit-Limit: 60
> X-RateLimit-Remaining: 0
> X-RateLimit-Reset: 1377013266

> {
>    "error": {
>        "code": 429
>        "message": "API rate limit exceeded. Please try again in 60 seconds"
>    }
> }

Test & Environments

The Bounce API is currently only available in a production environment.

Mock APIs for testing and development will be available soon.

API documentation

To review the documentation for each Bounce service, follow the links below:

🏷️Link API🌐Flex API🤝Partner API