Autenticación de contratos
Para que el servicio de AutoPay pueda interactuar con tu API siguiendo los contratos definidos debes autenticar tus peticiones, de esta forma podrás identificarnos y validar la información para que tus operaciones sean seguras. La API debe utilizar HTTP Basic Authentication (Basic Auth).
Credenciales API
En la integración con AutoPay se debe contar con las credenciales username y password del comercio implementador.
- username: Usuario que el comercio implementador debe proveer a AutoPay durante la configuración del sitio. Máximo 60 caracteres.
- password: Contraseña que el comercio implementador debe proveer a AutoPay durante la configuración del sitio. Máximo 60 caracteres.
Estas credenciales serán usadas por AutoPay para autenticarse contra los contratos/servicios del comercio, por lo tanto el comercio debe validarlas en cada solicitud entrante.
Estas credenciales son propias del comercio y deben ser tratadas de forma segura. No comparta sus credenciales en áreas de acceso público como Github, código del lado de cliente u otros lugares de fácil acceso para terceros.
Objeto Authentication
La autenticación se envía en headers en cada solicitud que AutoPay realice hacia los contratos del comercio.
- Name
Authorization- Type
- string
- is Required
- REQUIRED
- Description
Header requerido. Se envía con el formato: Basic base64(username:password)
Autenticación de Ejemplo (Header)
Authorization: Basic bWVyY2hhbnRVc2VyOm1lcmNoYW50UGFzcw==
Cómo validar la autenticación
Debes conocer y preparar los siguientes datos:
username: Usuario que configuraste para que AutoPay consuma tus contratos. Máximo 60 caracteres.
password: Contraseña que configuraste para que AutoPay consuma tus contratos. Máximo 60 caracteres.
Authorization: Header recibido en la petición, con el formato:
Authorization: Basic base64(username:password)
Reglas de validación basicas
- Verificar que exista el header
Authorization. - Verificar que el esquema sea
Basic. - Decodificar el token Base64 y obtener el texto
username:password. - Separar
usernameypassword. - Comparar contra tus credenciales configuradas.
- Si falla, responder
401 Unauthorized(opcionalmente conWWW-Authenticate).
La autenticación Basic debe viajar siempre sobre HTTPS. Base64 no cifra, solo codifica.