Resumo
Cada endpoint da API HTTP do Tillor, com parâmetros, pedidos de exemplo e um playground.
Última atualização em
Esta referência é gerada diretamente a partir da API do Tillor. Cada endpoint tem a sua própria página com parâmetros, corpo do pedido, respostas possíveis e exemplos de código. Na barra lateral, os endpoints estão agrupados por tema.
Enviar um pedido
Todos os pedidos precisam da sua chave de API no cabeçalho x-api-key. Os endpoints em /orgs/{organizationId} funcionam dentro de uma só organização.
GET https://api.tillor.eu/orgs/org_abc123/customers
x-api-key: tkn_xxxCria uma chave de API na aplicação, na sua conta. Como funciona, que limites de pedidos se aplicam e como guardar as chaves em segurança, leia em API HTTP.
Quem pode chamar um endpoint
Cada página de endpoint mostra no topo, em Acesso, quem o pode chamar. Na maioria dos endpoints é um membro da organização com uma permissão específica, como customers:read. Uma chave de API funciona com as permissões da pessoa que a criou; se a chave tiver scopes, a permissão também tem de estar neles. Caso contrário, a API responde 403.
A especificação tem a mesma informação por endpoint em x-tillor-access, com access (quem) e permissions (basta uma).
Experimentar no playground
Em cada página de endpoint pode enviar logo o pedido. Se tiver sessão iniciada no Tillor no mesmo navegador, o playground usa a sua sessão e não precisa de chave de API. Caso contrário, preencha a sua chave de API em Authorization. Ajuste os parâmetros e clique em Send.
O playground comunica com a API real da sua organização: um POST, PUT ou DELETE altera, portanto, dados reais.
Use uma organização de teste
Experimente os endpoints de escrita numa organização de teste, não no seu parque em funcionamento.
Descarregar a especificação
A especificação completa está disponível em OpenAPI 3.1 em tillor.eu/api/openapi.json. Importe-a no Postman ou no Insomnia, ou gere um cliente com ela.