Skip to main content
L’API Chataigne vous permet de connecter les opérations de vos restaurants à vos propres systèmes. Utilisez-la pour découvrir les restaurants accessibles à votre intégration, maintenir leurs informations et paramètres de commande à jour, et récupérer des données analytiques.
URL de base
L’API utilise des URL orientées ressources sous /v1, des corps de requête et de réponse en JSON, les méthodes HTTP standard et les codes de statut habituels. Chaque requête doit utiliser HTTPS et inclure une clé API Chataigne dans l’en-tête x-api-key.

Effectuer votre première requête

Authentifiez-vous et récupérez les établissements accessibles à votre intégration.

Comprendre vos accès

Découvrez comment le périmètre et les permissions d’une clé se combinent.

Organisations et établissements

Comprenez les deux ressources au cœur de l’API.

Trouver vos ressources

Découvrez l’organisation et les établissements accessibles à votre clé.

​
Modèle de ressources

Une organisation commerciale représente un groupe de restaurants ou une entreprise. Elle peut contenir un ou plusieurs établissements, chaque établissement représentant un restaurant individuel. Certaines intégrations reçoivent une clé limitée à une organisation commerciale et peuvent accéder à cette organisation ainsi qu’à ses établissements. D’autres reçoivent une clé limitée à un établissement unique. Un établissement autonome peut ne dépendre d’aucune organisation commerciale.
Le périmètre détermine les ressources qu’une clé peut atteindre. Les permissions déterminent les actions qu’elle peut effectuer sur ces ressources. Les deux doivent autoriser la requête.

​
Ce que vous pouvez faire

  • Découvrir votre organisation commerciale et vos établissements.
  • Mettre à jour le nom d’une organisation ou le profil d’un établissement.
  • Configurer les commandes, les horaires d’ouverture, la livraison, l’acceptation des commandes et les instructions du commis IA.
  • Planifier des fermetures exceptionnelles.
  • Récupérer les données analytiques d’un établissement ou d’une organisation.
Les ressources sont identifiées par des chaînes opaques telles que loc_…. Enregistrez et réutilisez les identifiants renvoyés par l’API ; ne déduisez aucune information de leur format.

​
Parcours recommandé

  1. Suivez le Démarrage rapide pour récupérer votre premier établissement.
  2. Lisez Clés API et permissions pour comprendre votre périmètre d’accès.
  3. Utilisez Trouver vos ressources pour obtenir les identifiants nécessaires à votre intégration.
  4. Continuez vers la Gestion des établissements ou les Données analytiques selon votre besoin.