Bien démarrer
Bienvenue dans la documentation de l'API
Vous trouverez ici tous les guides et la documentation de référence pour prendre en main notre API le plus rapidement possible.
L'API vous permet de connecter votre application à la plateforme Beedeez et d'y effectuer de nombreuses opérations. Nous la voulons pleinement RESTful, avec des réponses JSON claires et concises.
Comment cette documentation est organisée
La documentation se découpe en plusieurs sections. Bien démarrer présente les grands principes de l'API. La section Authentification explique comment authentifier votre application auprès de l'API.
La référence API couvre chaque type de ressource que l'API manipule (leçons, parcours, utilisateurs…), avec tous les endpoints disponibles, leurs paramètres et leurs réponses.
Premiers pas
Pour commencer, générez une clé secrète depuis le back office. Copiez-la aussitôt : elle ne s'affiche qu'une seule fois. Échangez ensuite cette clé contre un access token JWT de courte durée, puis envoyez ce token dans l'en-tête Authorization: Bearer de chacune de vos requêtes. Le guide Authentification détaille chaque étape.
Veillez à garder votre clé secrète et vos tokens confidentiels : ne les partagez jamais dans un espace public, comme GitHub ou du code exécuté côté client.
Envoyer des requêtes
Toutes les requêtes passent par HTTPS et doivent être authentifiées.
L'API suit des conventions prévisibles : des URL organisées par ressource et des codes de réponse HTTP standard pour signaler les erreurs. Elle s'appuie sur les mécanismes natifs de HTTP (authentification, verbes), compris par n'importe quel client HTTP du marché.
Spécification OpenAPI
Vous pouvez télécharger la spécification OpenAPI complète de l'API pour l'utiliser dans vos outils habituels, comme Postman, Insomnia ou un générateur de code.
📄 Télécharger la spécification OpenAPI
La spécification contient :
- la documentation complète de chaque endpoint
- les schémas des requêtes et des réponses
- les exigences d'authentification
- des exemples de requêtes et de réponses
Importez-la dans votre outil de développement d'API pour tester vos appels et accélérer votre intégration.
Versions
L'API est versionnée : elle peut ainsi évoluer en continu tout en restant stable pour les applications qui en dépendent. Chaque évolution donne lieu à une nouvelle version, et les versions précédentes restent disponibles pendant une période de transition pour vous laisser le temps de migrer.
Support
Nous espérons que cette documentation répond à toutes vos questions. Si vous rencontrez un problème ou avez une question, n'hésitez pas à contacter notre équipe support.
Nous avons hâte de découvrir ce que vous allez construire !