Beekube Device
Bienvenue dans la section développeur de Beekube. L'API ouvre un monde de possibilités pour les apiculteurs passionnés et les amateurs de bricolage (DIY) qui souhaitent intégrer leurs propres solutions connectées à l'écosystème Beekube. Qu'est-ce que l'API Beekube ?
L'API Beekube est une interface de programmation qui permet une communication fluide entre vos objets connectés DIY pour ruches, comme les balances de ruche connectées ou les stations météo, et la plateforme Beekube. Grâce à cette API, vous pouvez envoyer automatiquement les données collectées par vos dispositifs directement dans votre compte Beekube, vous permettant ainsi de surveiller et d'analyser ces informations en temps réel. Pourquoi utiliser l'API Beekube ?
- Intégration facile : L'API est conçue pour être simple et intuitive, permettant une intégration rapide de vos dispositifs avec Beekube.
- Suivi en temps réel : Obtenez des mises à jour immédiates de l'état de vos ruches directement sur votre tableau de bord Beekube.
- Personnalisation : Adaptez la gestion de vos ruches en fonction des données spécifiques recueillies par vos dispositifs connectés. Support et documentation complète : Nous vous fournissons toutes les informations nécessaires et l'assistance pour faciliter l'utilisation de notre API.
Comment démarrer ?
Pour commencer, rendez-vous dans la section Configuration > Développeur de votre compte Beekube. Vous pourrez alors générer votre clé API personnelle. Cette page vous donne également accès aux logs de vos appels API pour vérifier le bon fonctionnement de vos appareils.
Vous devez créer vos objets connectés en amont dans Objets connectés, avec le bouton Ajouter un objet connecté.
Document OpenAPI
Voici le lien de la documentation OpenAPI : https://www.beekube.com/docs/user_openapi.yaml
Authentication
- API Key: ApiKeyAuth
Authentification de l'API Beekube
L'authentification à l'API Beekube est assurée par l'utilisation d'une clé API. Cette clé est un token unique qui permet d'identifier et de sécuriser vos interactions avec l'API. Voici comment procéder pour l'utiliser :
Obtention de votre Clé API
- Accès à la clé : Connectez-vous à votre compte Beekube et naviguez vers la section
Configuration > Développeur. - Génération de la clé : Dans cette section, vous trouverez l'option pour générer votre clé API personnelle. Une fois générée, vous pouvez la copier pour l'utiliser dans vos requêtes API.
Utilisation de la Clé API
- Intégration dans les Requêtes : Pour chaque requête envoyée à l'API Beekube, vous devez inclure votre clé API. Elle doit être insérée dans l'en-tête HTTP de la requête sous la clé
X-API-KEY. - Format de l'En-tête : L'en-tête doit être structuré de la manière suivante :
X-API-KEY: VotreCléAPI.
Sécurité
- Confidentialité : Votre clé API est unique et doit rester confidentielle. Ne la partagez avec personne pour assurer la sécurité de vos données.
- Révocation et Régénération : En cas de compromission ou pour des raisons de sécurité, vous pouvez à tout moment révoquer et régénérer une nouvelle clé API depuis votre compte Beekube.
En suivant ces étapes simples, vous assurez une connexion sécurisée et authentifiée avec l'API Beekube, permettant une interaction fluide et sûre avec vos dispositifs connectés pour ruches.
| Security Scheme Type: | apiKey |
|---|---|
| Header parameter name: | X-API-KEY |