Démarrage rapide - Chataigne Docs

Ce guide vous accompagne depuis la réception de votre clé API jusqu’à la récupération d’un établissement accessible à votre intégration.

1. Enregistrer votre clé API

Votre contact Chataigne vous fournit une clé commençant par ch_org_. Enregistrez-la dans un gestionnaire de secrets ou une variable d’environnement sur votre serveur.

export CHATAIGNE_API_KEY="ch_org_..."

N’exposez jamais une clé API Chataigne dans du code pour navigateur ou application mobile, dans des journaux, des captures d’écran ou le contrôle de version. Si une clé est exposée, demandez son renouvellement à votre contact Chataigne.

2. Lister vos établissements

Transmettez la clé dans l’en-tête x-api-key. GET /v1/locations renvoie tous les établissements compris dans le périmètre de la clé et qu’elle est autorisée à lire.

curl https://server.chataigne.ai/v1/locations \
  -H "x-api-key: $CHATAIGNE_API_KEY"

const response = await fetch('https://server.chataigne.ai/v1/locations', {
  headers: { 'x-api-key': process.env.CHATAIGNE_API_KEY },
});

const body = await response.json();
if (!response.ok) {
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data);

import os
import requests

response = requests.get(
    "https://server.chataigne.ai/v1/locations",
    headers={"x-api-key": os.environ["CHATAIGNE_API_KEY"]},
)
body = response.json()
response.raise_for_status()

print(body["data"])

3. Lire la réponse de liste

Les endpoints de liste renvoient un objet liste. Le tableau data contient les ressources disponibles sur la page actuelle.

{
  "object": "list",
  "data": [
    {
      "id": "loc_r8v4n2c6tz",
      "object": "location",
      "organization_id": "busorg_k3m9x2p7qw",
      "name": "Café de la Gare",
      "currency": "EUR",
      "country": "FR",
      "timezone": "Europe/Paris",
      "default_language": "fr",
      "address": {
        "line1": "12 rue de la Gare",
        "postal_code": "75010",
        "city": "Paris",
        "country": "FR"
      },
      "created_at": "2026-01-14T09:30:00Z",
      "updated_at": "2026-05-02T16:45:12Z"
    }
  ],
  "has_more": false,
  "url": "/v1/locations"
}

Si la clé est limitée à une organisation commerciale, data peut contenir plusieurs établissements. Si elle est limitée à un établissement, data contient cet établissement. Consultez Organisations et établissements pour comprendre le modèle d’accès complet.

4. Récupérer un établissement

Copiez l’id d’un établissement depuis la liste et placez-le dans l’URL :

curl https://server.chataigne.ai/v1/locations/loc_r8v4n2c6tz \
  -H "x-api-key: $CHATAIGNE_API_KEY"

La réponse contient la ressource location complète. Conservez l’identifiant renvoyé : vous l’utiliserez dans les endpoints de paramètres et de données analytiques.

Résoudre les problèmes courants

Statut	Signification	Vérification
`401`	La requête n’a pas pu être authentifiée.	Vérifiez que `x-api-key` est présent et que la clé est à jour.
`403`	La clé ne peut pas effectuer cette action.	Vérifiez son périmètre et la permission `location.read`.
`404`	La ressource n’est pas disponible pour cette clé.	Vérifiez l’identifiant de l’établissement et le périmètre de la clé.

Chaque réponse inclut un en-tête X-Request-Id. Enregistrez-le et communiquez-le lorsque vous contactez l’assistance Chataigne.

Étapes suivantes

Trouver toutes vos ressources

Découvrez votre organisation et les différentes façons de lister ses établissements.

Gérer un établissement

Mettez à jour son profil et ses paramètres opérationnels.

​1. Enregistrer votre clé API

​2. Lister vos établissements

​3. Lire la réponse de liste

​4. Récupérer un établissement

​Résoudre les problèmes courants

​Étapes suivantes

Trouver toutes vos ressources

Gérer un établissement

1. Enregistrer votre clé API

2. Lister vos établissements

3. Lire la réponse de liste

4. Récupérer un établissement

Résoudre les problèmes courants

Étapes suivantes