Retour à la documentation

Référence API

Intégrez Gérant Pro à vos propres outils grâce à notre API REST.

Introduction

L'API Gérant Pro vous permet d'intégrer les fonctionnalités de Gérant Pro dans vos propres applications et outils. L'API est REST et retourne des réponses en JSON. Elle est disponible pour les utilisateurs des plans Pro et Business.

Authentification

Toutes les requêtes API nécessitent une clé API (apiKey) envoyée dans le corps de chaque requête. Vous pouvez générer votre clé API depuis les paramètres de votre compte, section "API". Gardez cette clé confidentielle et ne la partagez jamais publiquement.

URL de base

L'URL de base de l'API est :

  • Production : https://api.gerant.pro/api
  • Développement : http://localhost:3010/api

Format des réponses

Toutes les réponses suivent le même format JSON. En cas de succès :

{ "success": true, "data": { ... }, "meta": { ... } }

En cas d'erreur :

{ "success": false, "error": "Description de l'erreur" }

Le code HTTP retourné est toujours 200. Les erreurs sont transmises dans le corps de la réponse via le champ error.

Endpoints disponibles

Les principaux endpoints de l'API sont :

  • GET /api/products : récupérer la liste des produits du catalogue
  • POST /api/products : ajouter un nouveau produit
  • PATCH /api/products/:id : modifier un produit existant
  • DELETE /api/products/:id : supprimer un produit
  • GET /api/orders : récupérer la liste des commandes
  • POST /api/orders : créer une nouvelle commande
  • PATCH /api/orders/:id : mettre à jour le statut d'une commande
  • GET /api/customers : récupérer la liste des clients
  • POST /api/customers : ajouter un nouveau client
  • GET /api/alerts : récupérer les alertes actives

Exemple de requête

Voici un exemple de requête pour récupérer la liste de vos produits :

POST /api/products avec le corps { "apiKey": "votre-cle-api" }

La réponse contiendra un tableau de produits avec leurs identifiants, noms, prix et catégories.

Limites de taux

L'API est limitée à 100 requêtes par minute par clé API. Si vous dépassez cette limite, vous recevrez une erreur "Rate limit exceeded". Attendez quelques secondes avant de réessayer. Pour des besoins plus importants, contactez notre support pour discuter d'une augmentation de cette limite.

Support technique

Pour toute question technique sur l'API, contactez notre équipe de développement à dev@gerant.pro. Nous mettons régulièrement à jour la documentation et ajoutons de nouveaux endpoints. Consultez le changelog pour suivre les évolutions.