API PearsDB

L’API PearsDB vous permet d’interagir programmatiquement avec notre plateforme. Vous pouvez l’utiliser pour gérer vos modèles, données, et automatisations.

Authentication

Toutes les requêtes API doivent être authentifiées avec une clé API. Pour obtenir votre clé API :

  1. Connectez-vous à votre tableau de bord PearsDB
  2. Naviguez vers Paramètres > API
  3. Générez une nouvelle clé API
curl -X GET "https://api.pearsdb.com/v1/models" \
  -H "Authorization: Bearer votre_clé_api"

Format des Requêtes

L’API PearsDB accepte et renvoie des données au format JSON. Assurez-vous d’inclure l’en-tête Content-Type: application/json pour les requêtes POST et PUT.

Gestion des Erreurs

L’API utilise des codes de statut HTTP standard :

  • 200 : Succès
  • 400 : Erreur de requête
  • 401 : Non authentifié
  • 403 : Non autorisé
  • 404 : Ressource non trouvée
  • 500 : Erreur serveur

Les réponses d’erreur incluent des détails sur le problème :

{
  "error": {
    "code": "invalid_input",
    "message": "Le paramètre 'name' est requis",
    "details": {
      "field": "name",
      "type": "missing_field"
    }
  }
}

Pagination

Pour les endpoints qui renvoient des listes, la pagination est supportée via les paramètres limit et offset :

curl "https://api.pearsdb.com/v1/models?limit=10&offset=0"

La réponse inclut des métadonnées de pagination :

{
  "data": [...],
  "pagination": {
    "total": 100,
    "limit": 10,
    "offset": 0,
    "has_more": true
  }
}

Versions

L’API est versionnée via le chemin URL. La version actuelle est v1. Les versions précédentes sont supportées pendant au moins 12 mois après la sortie d’une nouvelle version.

Limites de Taux

Les limites de taux sont appliquées par clé API :

  • API Gratuite : 1000 requêtes/heure
  • API Pro : 10000 requêtes/heure
  • API Entreprise : Personnalisable

Les en-têtes de réponse incluent des informations sur votre utilisation :

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Ressources Supplémentaires

Pour toute question ou assistance, contactez notre support technique