Appearance
Credenciales
En Comafi usamos OAuth 2.0, que significa “Open Authorization” (autorización abierta), es un estándar diseñado para permitir que un sitio web o una aplicación accedan a recursos alojados por otras aplicaciones web en nombre de un usuario.
Se comparten credenciales según el ambiente donde se encuentre:
- Ambiente Sandbox: Utiliza las credenciales para comenzar tu desarrollo e integración de nuestras apis.
- Ambiente de Homologación: Utiliza las credenciales de prueba para probar tus integraciones. Con las credenciales de este ambiente se realizan los casos de homologación para luego poder pasar al ambiente productivo.
- Ambiente Productivo: Utiliza las credenciales de producción para operar.
Ambos tipos de credenciales constan de dos pares de claves que debes utilizar:
client_id: El ID de cliente es un identificador único que representa tu integración.client_secret: Clave privada para acceder a las funciones del sistema. Es extremadamente importante mantener esta información segura en tus servidores y no permitir el acceso a ningún usuario del sistema o intruso.
Obtener AccessToken
POST
/auth/realms/{realm}/protocol/openid-connect/token
Importante!
El accessToken tiene una duración de 5 minutos.
El refreshToken tiene una duración de 1 año.
Puedes pedir cuantos accessToken necesites. No se pisan entre ellos.
Autorizaciones
basicAuth
Tipo
HTTP (basic)
Parámetros
Header Parameters
User-Agent*
Header de identificación de cliente que envía la petición
Tipo
Requeridostring
Ejemplo
"nombre-cliente"Path Parameters
realm*
Realm correspondiente a ambiente de QA o Producción
Tipo
Requeridostring
Valores válidos
"external-qa-realm""Comafi-Realm"Ejemplos
"external-qa-realm"Cuerpo de la petición
application/x-www-form-urlencoded
Para generar por primera vez usar; 'client_credentials', para refrescar el token usar 'refresh_token'
Por defecto
"client_credentials"Enviar aca el token a refrescar.
Respuestas
Respuesta obtenida en caso de que las credenciales ingresadas sean correctas
application/json
JSON "access_token": "eyJhbGciOiJSUzI1NiIsInR5c...4XMhw", "expires_in": 300, "refresh_expires_in": 31536000, "refresh_token": "eyJhbGciOiJNDJlYi05Y...S_mHde3p39Hev9I3fwQQs", "token_type": "bearer", "not-before-policy": 1617721607, "session_state": "7fb98622-8418-4352-ab4c-38713c0373ac", "scope": "transfers email accounts"
{
}