Integraciones (API)#
Desde aquí puedes generar claves de API para que servicios externos (herramientas de BI, sistemas de reportes, integraciones propias) descarguen el histórico de pedidos de tu grupo de locales. Cada clave proporciona acceso solo de lectura a los pedidos del grupo que selecciones, sin poder modificar ni eliminar información.
Cómo usarlo#
- Crear una nueva clave: haz clic en «Crear» y rellena:
- Grupo de locales: selecciona a qué grupo de locales tendrá acceso la clave.
- Nombre / descripción: escribe un nombre descriptivo para identificar para qué sirve (ej.: «Integración BI de pedidos», «Dashboard externo»).
- Activa: marca esta casilla para que la clave funcione de inmediato (por defecto está activada).
- Copiar la clave: al guardar se mostrará la clave en claro. Cópiala al instante y guárdala en un lugar seguro (gestor de contraseñas, variable de entorno, etc.). Después solo será visible durante 15 minutos en el modal «Ver credenciales»; pasado ese tiempo solo podrás regenerarla.
- Ver credenciales y ejemplos: haz clic en «Ver credenciales» en la fila de la clave. Verás:
- La URL del endpoint de la API (para descargar pedidos).
- La clave (si aún está dentro de los 15 minutos tras crearla o regenerarla).
- Un ejemplo cURL listo para copiar y pegar en tu terminal.
- Un tab de «Uso de la API» con guía de filtros, paginación, ejemplos y buenas prácticas.
- Activar/desactivar: usa el botón «Editar» para cambiar el nombre o desactivar una clave sin borrarla (útil si la quieres pausar temporalmente).
- Regenerar una clave: si crees que se ha filtrado o simplemente quieres cambiarla, haz clic en «Regenerar». La clave anterior dejará de funcionar al instante, así que avisa al servicio externo para que la actualice.
- Eliminar: usa el botón «Eliminar» para borrar una clave definitivamente.
Consejos#
- Seguridad: trata la clave como una contraseña. Guárdala en un secreto (GitHub Secrets, variable de entorno, etc.), nunca en código fuente visible. Si se filtra, usa «Regenerar» para invalidarla al instante.
- Límite de uso: cada clave permite aproximadamente 240 peticiones por minuto. Para descargar históricos grandes, recorre las páginas de forma secuencial y no simultánea.
- Documentación detallada: si necesitas información completa sobre los filtros de búsqueda, paginación, estructura JSON de respuestas y casos de uso avanzados, consulta la guía técnica de la API de pedidos.
- Múltiples integraciones: puedes crear tantas claves como necesites. Usa nombres descriptivos para saber cuál es cuál, y una clave por servicio externo (en lugar de compartir la misma clave entre varios).