Aller au contenu principal
Version: v2

Beekube API

API Beekube v2 — Accédez à toutes vos données apicoles : ruchers, ruches, interventions, récoltes, reines, objets connectés. Configurez des webhooks pour recevoir des notifications en temps réel dans vos outils d'automatisation (Make, N8N, etc.).

Authentification​

Incluez votre clé API dans l'en-tête X-API-KEY de chaque requête. Générez votre clé dans Configuration > Développeur.

Pagination​

Les endpoints de liste retournent des résultats paginés. Utilisez les paramètres page et limit pour naviguer.

Webhooks​

Souscrivez à des événements pour recevoir des notifications HTTP en temps réel. Les payloads sont signés avec HMAC-SHA256.

Document OpenAPI​

https://www.beekube.com/docs/v2_openapi.yaml

Authentication​

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​

  1. Accès à la clé : Connectez-vous à votre compte Beekube et naviguez vers la section Configuration > Développeur.
  2. 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

Contact

Support Beekube: [email protected]