Panoramica
Ogni endpoint dell'API HTTP di Tillor, con parametri, richieste di esempio e un playground.
Ultimo aggiornamento il
Questo riferimento è generato direttamente dall'API di Tillor. Ogni endpoint ha una pagina propria con parametri, corpo della richiesta, possibili risposte ed esempi di codice. Nella barra laterale gli endpoint sono raggruppati per argomento.
Inviare una richiesta
Ogni richiesta richiede la tua chiave API nell'header x-api-key. Gli endpoint sotto /orgs/{organizationId} lavorano all'interno di una singola organizzazione.
GET https://api.tillor.eu/orgs/org_abc123/customers
x-api-key: tkn_xxxCrei una chiave API nell'app, nel tuo account. Come funziona, quali rate limit valgono e come conservare le chiavi in modo sicuro lo leggi in API HTTP.
Chi può chiamare un endpoint
Ogni pagina di endpoint mostra in alto, sotto Accesso, chi può chiamarlo. Per la maggior parte degli endpoint è un membro dell’organizzazione con un determinato permesso, come customers:read. Una chiave API funziona con i permessi della persona che l’ha creata; se la chiave ha degli scope, il permesso deve esserci anche lì. Altrimenti l’API risponde 403.
La specifica riporta la stessa informazione per ogni endpoint in x-tillor-access, con access (chi) e permissions (ne basta uno).
Provare nel playground
In ogni pagina di endpoint puoi inviare subito la richiesta. Se hai effettuato l'accesso a Tillor nello stesso browser, il playground usa la tua sessione e non ti serve una chiave API. Altrimenti inserisci la tua chiave API in Authorization. Modifica i parametri e clicca Send.
Il playground comunica con la vera API della tua organizzazione: un POST, PUT o DELETE modifica quindi dati reali.
Usa un'organizzazione di prova
Prova gli endpoint di scrittura su un'organizzazione di prova, non sul tuo parco in uso.
Scaricare la specifica
La specifica completa è disponibile come OpenAPI 3.1 su tillor.eu/api/openapi.json. Importala in Postman o Insomnia, oppure generaci un client.