Resumen
Cada endpoint de la API HTTP de Tillor, con parámetros, ejemplos de solicitud y un playground.
Última actualización el
Esta referencia se genera directamente a partir de la API de Tillor. Cada endpoint tiene su propia página con parámetros, cuerpo de la solicitud, posibles respuestas y ejemplos de código. En la barra lateral, los endpoints están agrupados por tema.
Enviar una solicitud
Cada solicitud necesita tu clave API en la cabecera x-api-key. Los endpoints bajo /orgs/{organizationId} funcionan dentro de una organización.
GET https://api.tillor.eu/orgs/org_abc123/customers
x-api-key: tkn_xxxUna clave API se crea en la aplicación, en tu cuenta. Cómo funciona, qué límites de uso se aplican y cómo guardar las claves de forma segura lo encuentras en API HTTP.
Quién puede llamar a un endpoint
Cada página de endpoint muestra arriba, en Acceso, quién puede llamarlo. En la mayoría de los endpoints es un miembro de la organización con un permiso concreto, como customers:read. Una clave API funciona con los permisos de la persona que la creó; si la clave tiene scopes, el permiso también debe estar entre ellos. Si no, la API responde 403.
La especificación lleva la misma información por endpoint en x-tillor-access, con access (quién) y permissions (basta con uno).
Probar en el playground
En cada página de endpoint puedes enviar la solicitud al instante. Si has iniciado sesión en Tillor en el mismo navegador, el playground usa tu sesión y no necesitas una clave API. Si no, introduce tu clave API en Authorization. Ajusta los parámetros y haz clic en Send.
El playground se comunica con la API real de tu organización: un POST, PUT o DELETE modifica por tanto datos reales.
Usa una organización de prueba
Prueba los endpoints de escritura en una organización de prueba, no en tu parque en uso.
Descargar la especificación
La especificación completa está disponible como OpenAPI 3.1 en tillor.eu/api/openapi.json. Impórtala en Postman o Insomnia, o genera un cliente a partir de ella.