Documentation
Intégrer React Box
React Box expose une API REST documentée au format OpenAPI. Cette page décrit comment explorer la spécification et comment connecter une application tierce au compte d'un utilisateur.
Spécification OpenAPI
La spécification complète et interactive est hébergée directement sur notre infrastructure. Elle liste chaque endpoint, ses paramètres, ses réponses et permet d'essayer les requêtes depuis le navigateur.
https://www.react-box.com/api/v1/openapiAuthentification
L'authentification est entièrement déléguée à WorkOS. Il n'existe pas de clé d'API à générer ou à faire tourner : chaque requête est rattachée à la session d'un utilisateur connecté, et les droits appliqués côté serveur sont ceux de cet utilisateur.
Connecter une application tierce
Pour qu'une application externe agisse sur un compte React Box, elle demande le consentement de l'utilisateur via WorkOS. Le flux est le même qu'un « Se connecter avec… » classique.
- 01
Enregistrer votre application
Nous créons pour vous une application dans notre tenant WorkOS. Vous recevez un identifiant client et définissez une ou plusieurs URLs de redirection autorisées.
- 02
Rediriger l'utilisateur
Votre application redirige l'utilisateur vers l'URL d'autorisation React Box, en précisant votre identifiant client et l'URL de redirection.
- 03
Consentement
L'utilisateur se connecte avec son compte React Box et accepte que votre application agisse en son nom.
- 04
Retour vers votre application
WorkOS redirige l'utilisateur vers l'URL que vous avez déclarée, avec un code d'autorisation à usage unique.
- 05
Échange du code
Votre serveur échange ce code contre une session. Toutes les requêtes vers l'API React Box sont ensuite authentifiées avec cette session.
Le protocole utilisé est standard et compatible avec la plupart des bibliothèques OAuth 2.0. La documentation WorkOS détaille l'ensemble des options disponibles côté client.
Demander un accès
L'enregistrement d'une application tierce est géré manuellement pour le moment. Contactez-nous avec une brève description de votre produit, votre URL de redirection et les données auxquelles vous souhaitez accéder.
Nous écrire — contact@react-box.comVersions
Cette documentation couvre la v1. Les évolutions non rétrocompatibles seront publiées sous une nouvelle version majeure, avec un préavis raisonnable avant tout retrait de l'ancienne.