Bounce Docs
  • Overview
    • ๐Ÿ‘‹Welcome to Bounce
  • Product Guides
    • ๐Ÿท๏ธLink - Authentic Phygitals
      • ๐Ÿ”ขLink Tag variants
    • ๐ŸŒFlex - Fan Experiences
      • ๐Ÿ”ŒSupported Platform
    • ๐Ÿ”ŽTrack - Metaverse Analytics
  • ๐Ÿ› ๏ธIntegration Guides
    • ๐Ÿ‘‹Integration Overview
    • ๐Ÿ“ฑWeb Portal
      • โน๏ธExperience Blocks
    • ๐Ÿ”—APIs & SDKs
      • Web notifications & forwarding
      • REST API
        • โ„น๏ธAPI Overview
        • ๐Ÿท๏ธLink API
        • ๐ŸŒFlex API
        • ๐ŸคPartner API
      • Bounce SDK
        • ๐ŸŒJavaScript (Web & RN)
        • ๐Ÿ‘พUnity (iOS & Android)
        • ๐Ÿค–Roblox
    • ๐Ÿ“ƒOn-chain Interface
    • ๐Ÿ›’E-commerce plugins
    • ๐Ÿค–Platform-specific guides
  • Partner Info
    • ๐ŸงพPlans & Pricing
    • ๐Ÿ“Brand Guidelines
    • โ”Help & Support
Powered by GitBook
On this page
  • API Usage
  • Authentication
  • Rate limiting
  • Test & Environments
  • API documentation

Was this helpful?

  1. Integration Guides
  2. APIs & SDKs
  3. REST API

API Overview

Integrate Bounce API with backend, frontend and applications

PreviousREST APINextLink API

Last updated 1 year ago

Was this helpful?

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 . 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

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:

The time at which the current rate limit window resets in .

๐Ÿ› ๏ธ
๐Ÿ”—
โ„น๏ธ
Bearer Auth scheme
๐Ÿท๏ธLink API
๐ŸŒFlex API
๐ŸคPartner API
UTC epoch seconds