Integrate React Box

OpenAPI Specification

The complete interactive specification is hosted directly on our infrastructure. It lists every endpoint, its parameters, its responses, and lets you try requests from the browser.

Authentication

Authentication is fully delegated to WorkOS. There are no API keys to generate or rotate: every request is tied to a signed-in user's session, and the permissions applied server-side are those of that user.

Connect a third-party application

For an external application to act on a React Box account, it requests the user's consent via WorkOS. The flow is the same as a classic "Sign in with…".

1. 01

   Register your application

   We create an application for you in our WorkOS tenant. You receive a client ID and define one or more allowed redirect URLs.

2. 02

   Redirect the user

   Your application redirects the user to the React Box authorisation URL, specifying your client ID and redirect URL.

3. 03

   Consent

   The user signs in with their React Box account and agrees to let your application act on their behalf.

4. 04

   Return to your application

   WorkOS redirects the user to the URL you declared, with a one-time authorisation code.

5. 05

   Code exchange

   Your server exchanges this code for a session. All subsequent requests to the React Box API are authenticated with that session.

The protocol used is standard and compatible with most OAuth 2.0 libraries. The WorkOS documentation details all available client-side options.

Request access

Third-party application registration is handled manually for now. Contact us with a brief description of your product, your redirect URL, and the data you wish to access.

Versioning

This documentation covers v1. Breaking changes will be published under a new major version, with reasonable notice before any old version is removed.