Aller au contenu

Documentation

Démarrer en cinq minutes

Créer une clé de test, faire un premier appel et lire sa réponse.

Créer une clé de test

  1. Connectez-vous à votre compte Pillr, ou créez-en un.
  2. Ouvrez le tableau de bord, nommez votre organisation, puis créez une clé de test pk_test_.
  3. Copiez-la tout de suite : Pillr n'en garde qu'une empreinte, elle ne s'affiche qu'une fois.

Une clé pk_test_ répond sans débit sur le jeu figé du bac à sable de chaque opération qui en a un. Le même code passe ensuite en production avec une clé pk_live_.

Garder la clé hors du code

Les exemples lisent la clé dans la variable d'environnement PILLR_CLE : elle ne s'écrit jamais en clair dans une commande ni dans un dépôt.

Terminal
export PILLR_CLE=pk_test_...

Premier appel

Marché d'une commune : 1 crédit par appel réussi. Cette entrée est dans le bac à sable : une clé pk_test_ obtient la réponse, sans débit.

curl https://pillr.fr/api/v1/communes/76540 \
  -H "Authorization: Bearer $PILLR_CLE"

Le même appel se fait sans écrire de code dans l'essai en direct.

Lire la réponse

Une réponse réussie est un objet JSON compact. Elle porte le bloc credits : debites pour cet appel, restants pour ce qui reste à l'organisation (null en bac à sable). Les en-têtes disent le reste :

Pillr-Credits-Debites
Crédits débités par cet appel.
Pillr-Credits-Restants
Crédits restants : forfait du mois et recharges.
Pillr-Donnees-Du
Date de la donnée servie, quand elle est connue.
Pillr-Age-Donnees
Âge de cette donnée, en secondes.
ETag
À renvoyer dans If-None-Match : une réponse inchangée revient en 304, sans débit.
RateLimit-Limit
Requêtes permises par minute à votre organisation.
RateLimit-Remaining
Requêtes restantes dans la minute en cours.
RateLimit-Reset
Secondes avant la minute suivante.
Pillr-Requete
Identifiant de la requête, à citer au support.
Pillr-Mode
Live ou test, selon la clé.

Ensuite

  • La référence de chaque opération, par domaine : paramètres, champs rendus, coût, erreurs et exemples.
  • Le contrat OpenAPI, pour générer un client.
  • Le serveur MCP, pour donner ces opérations à un assistant avec la même clé.
  • Les erreurs et les limites, avant la production.

Guide suivant : Authentification

    Démarrer en cinq minutes | Pillr Data