Prezentare generală
Fiecare endpoint al API-ului HTTP Tillor, cu parametri, exemple de cereri și un playground.
Ultima actualizare la
Această referință este generată direct din API-ul Tillor. Fiecare endpoint are propria pagină, cu parametri, corpul cererii, răspunsurile posibile și exemple de cod. În bara laterală, endpoint-urile sunt grupate pe subiecte.
Trimiterea unei cereri
Fiecare cerere are nevoie de cheia dumneavoastră API în antetul x-api-key. Endpoint-urile de sub /orgs/{organizationId} funcționează în cadrul unei singure organizații.
GET https://api.tillor.eu/orgs/org_abc123/customers
x-api-key: tkn_xxxCreați o cheie API în aplicație, la contul dumneavoastră. Cum funcționează, ce limite de rată (rate limits) se aplică și cum păstrați cheile în siguranță citiți la API HTTP.
Cine poate apela un endpoint
Fiecare pagină de endpoint arată sus, la Acces, cine îl poate apela. Pentru majoritatea endpointurilor este un membru al organizației cu o anumită permisiune, de exemplu customers:read. O cheie API lucrează cu permisiunile persoanei care a creat-o; dacă cheia are scopuri, permisiunea trebuie să fie și printre ele. Altfel API-ul răspunde cu 403.
Specificația conține aceeași informație pentru fiecare endpoint în x-tillor-access, cu access (cine) și permissions (una este suficientă).
Încercarea în playground
Pe fiecare pagină de endpoint puteți trimite cererea imediat. Dacă sunteți autentificat în Tillor în același browser, playground-ul folosește sesiunea dumneavoastră și nu aveți nevoie de cheie API. Altfel, introduceți cheia API la Authorization. Modificați parametrii și faceți clic pe Send.
Playground-ul comunică cu API-ul real al organizației dumneavoastră: un POST, PUT sau DELETE modifică deci date reale.
Folosiți o organizație de test
Încercați endpoint-urile de scriere pe o organizație de test, nu pe parcul dumneavoastră în funcțiune.
Descărcarea specificației
Specificația completă este disponibilă ca OpenAPI 3.1 la tillor.eu/api/openapi.json. Importați-o în Postman sau Insomnia sau generați un client cu ea.