Skip to main content
Nuestra API te permite extender la funcionalidad de Quentli para desarrollar integraciones con sistemas externos, como CRMs, ERPs y otras aplicaciones web.

​
Endpoint

El endpoint base de la API REST de Quentli es el siguiente:

​
Referencia de endpoints

La especificación OpenAPI de la API REST está disponible en GET /openapi.json. También puedes descargarla en GET /openapi.yaml. Incluye endpoints para clientes, facturas, suscripciones, sesiones de pago, métodos de pago y webhooks.

​
Autenticación

Todas las consultas de la API en Quentli requieren una API key válida. Consulta Autenticación para obtener una key y enviarla con el encabezado Authorization.

​
Ejemplos

​
Crear un cliente

Ejemplo de cómo crear un cliente a través de la API REST.
POST /v1/customers
Toma en cuenta que los identificadores (username), correo electrónico y número de teléfono deben ser únicos. No pueden repetirse en otros clientes.

​
Crear una solicitud de pago

Puedes hacer la siguiente solicitud para crear una solicitud de pago a un cliente. Para ello, deberás primero crear un concepto de pago y un cliente previamente.
POST /v1/invoices

​
Paginación

Los endpoints que obtienen listas de recursos en Quentli máximo pueden devolver 100 registros a la vez. Para obtener la lista completa, soportamos paginación basada en offset. La paginación en Quentli se maneja usando dos parámetros: take y skip . Ambos parámetros son opcionales.
  • take : indica cuántos items deseas obtener en tu solicitud. Por default, este valor es 20. El valor máximo de take es 100.
  • skip : indica cuántos items deseas “saltar”. Por default, este valor es 0.
Por ejemplo, si deseas obtener los primeros 10 invoices y después obtener los siguientes 10 harías las siguientes llamadas:

​
Idempotencia

Recomendamos enviar un X-Idempotency-Key único en operaciones de escritura que puedan crear o modificar cobros, y reutilizarlo al reintentar la misma solicitud. Consulta Idempotencia para conocer el comportamiento, los límites y cómo manejar respuestas 4xx y 5xx.

​
Formatos y convenciones

  • Los montos en la API están en unidades menores de la moneda indicada. Por ejemplo, para cobrar $150.00 MXN, usa 15000 con currency: "MXN".
  • En la API de Quentli, las fechas se admiten y devuelven en el formato ISO 8601 con la zona horaria UTC. Por ejemplo: 2025-01-09T06:00:00.000Z indica el inicio del 9 de enero de 2025 en hora Ciudad de México.
  • El formato de los números de celular es E.164, que incluye el código de país y a continuación el número local. Por ejemplo: +525512345678
  • El formato de las monedas internacionales es ISO 4217, que utiliza un código de 3 letras. Por ejemplo, el peso mexicano es MXN y el dólar estadounidense es USD

​
Restricciones (rate limits)

La API REST permite hasta 1,000 solicitudes por minuto desde una misma dirección IP. Cuando se alcanza el límite, recibirás 429 Too Many Requests y un encabezado Retry-After con el tiempo que debes esperar antes de reintentar. Consulta Límites de solicitudes para conocer los encabezados disponibles, recomendaciones de reintento y cómo combinarlo con idempotencia en operaciones de escritura.