1.png?fit=max&auto=format&n=4-5R_aQB0EkHGUZD&q=85&s=9d9475963092edc3d5df46df2866696a)
Cómo funciona
1
Obtén tu API Key
Tu API Key es un identificador único de 364 caracteres asignado a tu negocio. El equipo de PayCode te la proporciona al configurar tu cuenta.
2
Solicita un token de acceso
Envía tu API Key al endpoint de autenticación. El sistema te regresa un
access_token que usarás en todas las peticiones siguientes.3
Incluye el token en cada petición
Agrega el token en el header
Authorization de cada llamada con el formato Bearer {token}.Endpoint de autenticación
Método:GET Endpoint: /Api/v2/auth/login
Header requerido:
Ejemplo de respuesta — 200 OK:
Guarda el valor de
access_token. Lo necesitarás en todas las peticiones siguientes con el formato Authorization: Bearer {access_token}.Vida del token
Cuando el token expira el sistema regresa un error
401 Token Expired. En ese momento tienes dos opciones:
Opción 1: Generar un nuevo token Vuelve a llamar al endpoint de autenticación con tu API Key. Es la opción más sencilla.
Opción 2: Usar el refresh token Si tu integración es automatizada puedes renovar el token sin necesidad de hacer login de nuevo.
Para integraciones automatizadas se recomienda implementar la renovación del token antes de que expire para evitar interrupciones en el servicio.
El endpoint y el proceso del refresh token estarán disponibles próximamente.
Seguridad
Rate limiting
El rate limiting define cuántas peticiones puede hacer tu integración a un endpoint en un periodo de tiempo determinado.El rate limiting aplica actualmente solo al endpoint de consulta de transacciones. Los demás endpoints no tienen límite definido.