Headers comunes, paginación y cuentas de cobro.
Headers comunes a toda la API y convenciones de requests.
Headers
| Header | Uso |
|---|---|
x-api-key | Autenticación con API Key. Ver Autenticación. |
Authorization | Autenticación con OAuth M2M: Bearer <access_token>. Reemplaza a x-api-key en las organizaciones que tienen OAuth habilitado. Ver Autenticación. |
x-api-version | Versión de la API por fecha. Ver Versionamiento. |
x-account-key | Llave única que identifica la Cuenta de cobro cuando tu organización tiene más de una. |
Content-Type | Siempre application/json. |
Body
El body de cada request va en JSON:
{
"mail": "[email protected]",
"name": "Jon Snow",
"phone_number": "+56987654321"
}Cuentas de cobro
Si tu organización recibe dinero en distintas cuentas, cada request puede indicar con qué cuenta operar usando x-account-key.
Cada Cuenta de cobro tiene su propia llave, que obtienes en el Backoffice al crearla, en Ajustes → Cuentas de cobro.
El header es opcional y sólo aplica si configuraste más de una cuenta: si lo omites, la operación se resuelve contra la cuenta predeterminada.
Paginación
Los endpoints que listan recursos devuelven una página a la vez. Todos aceptan page_size para fijar el tamaño de la página — su valor por omisión y su máximo dependen del endpoint — y se recorren de dos formas según el recurso.
Por cursor. La respuesta trae los elementos en items y un next_cursor. Envía ese valor en el parámetro next_cursor para pedir la página siguiente, y omítelo en la primera llamada. El campo viene siempre en la respuesta: cuando llega en null, no quedan más páginas.
curl "https://api.trytoku.com/invoices?page_size=50&next_cursor=EXAMPLE_CURSOR" \
-H "x-api-key: TU_API_KEY"Por número de página. La respuesta trae los elementos en items y un total_results con el total que cumple los filtros, sin considerar la paginación. Pide cada página con page, partiendo en 1.
curl "https://api.trytoku.com/transactions?page=2&page_size=50" \
-H "x-api-key: TU_API_KEY"Cada listado documenta cuál de las dos usa, junto a sus filtros propios, en la categoría Recursos.