Introduction à l'API MyRuche
L'API REST MyRuche vous permet d'accéder en lecture et en écriture à toutes vos données apicoles. Que vous souhaitiez connecter MyRuche à votre logiciel de gestion agricole, créer des dashboards personnalisés ou automatiser des workflows, l'API est la porte d'entrée.
Base URL : `https://api.myruche.io/v1`Authentification
L'API utilise les Bearer tokens JWT pour l'authentification. Générez votre clé API depuis Paramètres > API > Nouvelle clé.
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.myruche.io/v1/apiaries
Endpoints principaux
Ruchers
GET /apiaries — Lister vos ruchers
GET /apiaries/:id — Détail d'un rucher
POST /apiaries — Créer un rucher
Ruches
GET /apiaries/:id/hives — Lister les ruches d'un rucher
GET /hives/:id — Détail d'une ruche
GET /hives/:id/metrics — Métriques temps réel
GET /hives/:id/metrics/history — Historique (avec pagination)
Alertes
GET /alerts — Alertes actives
PUT /alerts/:id/read — Marquer comme lue
Exemple : récupérer le poids d'une ruche
const response = await fetch(
'https://api.myruche.io/v1/hives/hive_abc123/metrics',
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
}
}
);
const data = await response.json();
console.log(data);
// {
// hive_id: "hive_abc123",
// name: "Ruche Lavande",
// metrics: {
// weight: { value: 42.3, unit: "kg", trend: "+0.8" },
// temperature: { value: 34.2, unit: "°C", status: "normal" },
// humidity: { value: 62, unit: "%", status: "normal" },
// health_score: 92,
// updated_at: "2026-03-24T10:15:00Z"
// }
// }
Webhooks
Configurez des webhooks pour recevoir des notifications en temps réel lors d'événements critiques :
POST /webhooks
{
"url": "https://votre-serveur.com/webhook",
"events": ["alert.critical", "swarming.predicted", "hive.offline"],
"secret": "your_webhook_secret"
}
Rate limiting
- •Plan Starter : 100 req/min
- •Plan Pro : 1 000 req/min
- •Plan Enterprise : illimité
Les headers `X-RateLimit-Remaining` et `X-RateLimit-Reset` sont inclus dans chaque réponse.
SDK disponibles
Des SDK officiels sont disponibles pour :
- •JavaScript/TypeScript : `npm install @myruche/sdk`
- •Python : `pip install myruche`
- •PHP : `composer require myruche/sdk`