Aperçu
Chaque endpoint de l'API HTTP de Tillor, avec ses paramètres, des exemples de requêtes et un playground.
Dernière mise à jour le
Cette référence est générée directement à partir de l'API Tillor. Chaque endpoint a sa propre page avec les paramètres, le corps de la requête, les réponses possibles et des exemples de code. Dans la barre latérale, les endpoints sont regroupés par thème.
Envoyer une requête
Chaque requête a besoin de votre clé API dans l'en-tête x-api-key. Les endpoints sous /orgs/{organizationId} fonctionnent au sein d'une seule organisation.
GET https://api.tillor.eu/orgs/org_abc123/customers
x-api-key: tkn_xxxVous créez une clé API dans l'application, sous votre compte. Pour savoir comment cela fonctionne, quelles limites de débit s'appliquent et comment conserver vos clés en sécurité, consultez API HTTP.
Qui peut appeler un point de terminaison
Chaque page de point de terminaison indique en haut, sous Accès, qui peut l’appeler. Pour la plupart, il s’agit d’un membre de l’organisation avec une autorisation donnée, comme customers:read. Une clé API fonctionne avec les autorisations de la personne qui l’a créée ; si la clé a des scopes, l’autorisation doit aussi y figurer. Sinon, l’API répond 403.
La spécification contient la même information par point de terminaison dans x-tillor-access, avec access (qui) et permissions (une seule suffit).
Essayer dans le playground
Sur chaque page d'endpoint, vous pouvez envoyer la requête immédiatement. Si vous êtes connecté à Tillor dans le même navigateur, le playground utilise votre session et vous n'avez pas besoin de clé API. Sinon, saisissez votre clé API sous Authorization. Adaptez les paramètres et cliquez sur Send.
Le playground communique avec la véritable API de votre organisation : un POST, PUT ou DELETE modifie donc de vraies données.
Utilisez une organisation de test
Essayez les endpoints d'écriture sur une organisation de test, pas sur votre parc en exploitation.
Télécharger la spécification
La spécification complète est disponible au format OpenAPI 3.1 sur tillor.eu/api/openapi.json. Importez-la dans Postman ou Insomnia, ou générez-en un client.