Aller au contenu principal

Référence API

L'API Grillo fournit un accès programmatique aux données des capteurs, aux informations sur les événements et aux fonctionnalités de la plateforme.

Accès API

L'accès à l'API nécessite une clé API. Générer votre clé API →

Aperçu​

L'API Grillo vous permet de :

  • Interroger les informations et le statut des capteurs
  • Accéder aux catalogues et détails des événements
  • Exporter des données de manière programmatique
  • Recevoir des notifications d'événements en temps réel
  • Gérer les configurations réseau

URL de base​

https://api.grillo.io/v1

Authentification​

Toutes les requêtes API nécessitent une authentification via clé API.

Incluez votre clé dans l'en-tête Authorization :

Authorization: Bearer VOTRE_CLE_API

Guide d'authentification détaillé →

Démarrage rapide​

Obtenir vos capteurs​

curl -H "Authorization: Bearer VOTRE_CLE_API" \
  https://api.grillo.io/v1/sensors

Obtenir les événements récents​

curl -H "Authorization: Bearer VOTRE_CLE_API" \
  https://api.grillo.io/v1/events?limit=10

Sections de l'API​

Capteurs​

Gérer et interroger les informations des capteurs :

  • Lister les capteurs de vos réseaux
  • Obtenir les détails et le statut des capteurs
  • Interroger les données des capteurs

Événements​

Accéder aux données des séismes :

  • Interroger le catalogue d'événements
  • Obtenir les détails des événements
  • Exporter les données d'événements

Réseaux​

Gérer les réseaux sismiques :

  • Lister les réseaux
  • Obtenir les informations réseau
  • Interroger les statistiques réseau

Webhooks​

Configurer les notifications en temps réel :

  • Configurer les endpoints webhook
  • Gérer les abonnements
  • Voir l'historique des livraisons

Format de réponse​

Toutes les réponses sont en JSON :

{
  "data": { ... },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2024-01-15T14:32:45Z"
  }
}

Réponses d'erreur​

{
  "error": {
    "code": "invalid_request",
    "message": "Description de l'erreur",
    "details": { ... }
  },
  "meta": {
    "request_id": "req_abc123"
  }
}

Limites de débit​

NiveauRequêtes/minuteRequêtes/jour
Gratuit6010 000
Standard300100 000
Premium1 000Illimité

En-têtes de limite de débit dans la réponse :

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1610000000

Pagination​

Les endpoints de liste supportent la pagination :

GET /v1/sensors?page=2&limit=50

La réponse inclut les informations de pagination :

{
  "data": [...],
  "pagination": {
    "page": 2,
    "limit": 50,
    "total": 150,
    "pages": 3
  }
}

Guides de cette section​

SDKs et bibliothèques​

SDKs officiels bientôt disponibles pour :

  • Python
  • JavaScript/Node.js
  • Et plus

Support​

Pour le support API :