Autenticación (Solicitar TOKEN)#
La solicitud de TOKEN se utiliza para poder realizar peticiones/consumos de manera segura a la capa de microservicios (servicios basados en API REST), expuesta por SOVOS Saphety.
Toda nuestra capa de microservicios utiliza JSON Web TOKEN (JWT), como sistema de autenticación utilizando el usuario (correo electrónico) y contraseña (configurada por el usuario) para poder usar los demás métodos expuestos de la capa de microservicios.
Metodo Ambiente de QA y Producción#
El método que se utiliza para la obtención de TOKEN es:
/v2/auth/gettoken
El verbo para la obtención del TOKEN es:
POST
No se requiren parámetros adicionales
Body#
En el cuerpo de esta petición, debemos enviar la siguiente estructura:
{
"username": "string",
"password": "string",
"virtual_operator": "string"
}
“username” o “usuario”, es el correo electrónico que suministró para la creación de cuenta en Saphety.
“password” o “contraseña”, es la asignada por el usuario en el momento de la activación de la cuenta.
“virtual_operator”, es el alias del operador virtual. Importante, tener en cuenta que por defecto el alias del operador virtual aparecerá como saphety.
Respuesta#
{
"IsValid": true,
"Warnings": [],
"Errors": [],
"ResultData": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnaXZlbl9uYW1lIjoiS2l0IFByZXZlbnRhIiwidW5pcXVlX25hbWUiOiJpb3J3dXp6bnJqemJnenRia3pAdHRpcnYub3JnIiwibmFtZWlkIjoiNWE2ZGU5YTYtZWE4Ni00MDdmLTk2MGItNzM2MzgwYmNkNDIzIiwibGFuZ3VhZ2UiOiJlcy1DTyIsInVzZXJ0eXBlIjoiVXNlciIsInZpcnR1YWxvcGVyYXRvciI6InNhcGhldHkiLCJuYmYiOjE2ODUwMzMwODgsImV4cCI6MTY4NTA3NjI4OCwiaWF0IjoxNjg1MDMzMDg4LCJpc3MiOiJsb2NhbC1hdXRoIiwiYXVkIjoiaHR0cDovL2xvY2FsLWFwaSJ9.gRys9Npo1crGPnmX6UttW0zBNcnUJGpDIBwkJuE4ZZ4",
"expires": "2023-05-26T04:44:48.2524735Z",
"token_type": "bearer",
"virtual_operator_alias": "saphety"
},
"ResultCode": 200
}
{
"IsValid": false,
"Warnings": [],
"Errors": [
{
"Field": null,
"Code": "IdentificationDoesNotMatch",
"Description": null,
"ExplanationValues": []
}
],
"ResultData": null,
"ResultCode": 400
}
Important
El Status 401, sucede en los casos de que el TOKEN caducó (tiene duración máxima de 2 horas) o es erróneo.
Referencia: Swagger#
Si quieres más información dirígete a Swagger que es el modelo del API de SOVOS Saphety, para el ambiente de QA https://api-factura-electronica-co-qa.saphety.com/swagger/index.html y para el ambiente de producción https://api-factura-electronica-co.saphety.com/swagger/index.html