Saltar al contenido principal

Para desarrolladores

Esta sección está dirigida a desarrolladores que integran su aplicación con TPVReady — chatbots, automatizaciones, paneles de BI, sincronizaciones con otros sistemas, o aplicaciones móviles propias.

Si eres cliente de TPVReady y quieres aprender a generar tus propias API Keys, consulta la sección API Keys del panel de configuración.

¿Qué es la API de TPVReady?​

TPVReady expone una API REST sobre HTTPS que permite consultar y modificar datos del ERP desde aplicaciones externas. Toda la API:

  • Devuelve y acepta JSON UTF-8.
  • Usa identificadores UUID (no IDs numéricos).
  • Aplica multitenancy automático — cada credencial solo ve los datos de su empresa.
  • Soporta dos modelos de autenticación según el caso de uso.

URL base​

https://api.tpvready.es/api

Los dos modelos de autenticación​

ModeloCuándo usarloCómo se envía
JWTApps con usuarios humanos que inician sesiónAuthorization: Bearer <token>
API KeyServidor-a-servidor, integraciones sin humanoX-API-Key: <clave>

Lee los detalles en Autenticación → Visión general.

Referencia interactiva de endpoints​

La lista completa de endpoints, sus parámetros, esquemas y respuestas está disponible en formato OpenAPI/Scalar generado automáticamente desde el código:

👉 https://api.tpvready.es/docs

Allí puedes:

  • Ver todos los endpoints públicos.
  • Consultar el JSON de request/response de cada uno.
  • Probarlos directamente desde el navegador (botón "Try it").
Documentación conceptual vs referencia técnica

Las páginas que vienen a continuación cubren los conceptos (cómo autenticarse, cómo manejar errores, qué scopes existen…). Para la lista detallada de endpoints usa el /docs enlazado arriba — siempre está sincronizado con el código en producción.

Por dónde empezar​

  1. Lee Autenticación → Visión general para decidir si usarás JWT o API Key.
  2. Si vas a usar API Key: lee Autenticación → API Keys y Scopes y permisos.
  3. Si vas a usar JWT: lee Autenticación → JWT.
  4. Revisa Convenciones y Códigos de error.
  5. Aplica las Buenas prácticas en tu implementación.
  6. Consulta la Referencia interactiva cuando necesites los detalles de cada endpoint.

¿Necesitas ayuda?​