Login

REFERENCIA DE API DE LOGIN - TOKEN BEARER

v1.0

Introducción

Bienvenido al API de Login del Ecosistema apithy, puede utilizarlo para obtener el token bearer que le dará acceso al uso de múltiples APIs dentro del ecosistema.

URL base

Para apuntar el endpoint al ambiente de pruebas, utilizar:

https://api.stage.apithy.com

Este ambiente de pruebas tiene un horario de disponibilidad de 14:00 a 00:00 horas UTC.

Para apuntar el endpoint al ambiente de producción, utilizar:

https://api.apithy.com

Este ambiente de producción no tiene límite de tiempo, está disponible 24x7x365.

Endpoint

• /auth/login

Solicitud por método POST.

Parámetros

Cuerpo de la solicitud.

Nombre	Tipo	Requerido	Descripción	Valores
email	string	true	Correo electrónico del usuario. Debe existir en apithy y tener licencia activa.	consumption
password	string	true	Contraseña en apithy del usuario.	consumption

Cuerpo de respuesta

Nombre	Tipo	Descripción
id	Number	Número interno, identificador del usuario.
uuid	String	Número identificador del usuario en el ecosistema apithy, se utiliza para todas las búsquedas.
email	String	Correo electrónico
status	JSON Array	Incluye el identificador del usuario (“id”), el código que identifica al estatus (“code”) y el nombre del estatus (“name”).
roles	JSON Array	Presenta todos los roles que tiene el usuario en el ecosistema apithy. Incluye el identificador del rol (“id”), el identificador único del rol (“uuid”), el nombre del rol (“name”), el nombre interno del rol (“code_name”), el nivel del rol (“level”), la descripción del rol (“description”) y si es un rol que se muestra en front-end (“allow_show”).
person	JSON Array	Contiene toda la información del usuario, las configuraciones regionales que ha escogido o en su defecto, las de la empresa, así como la suscripción que tiene.
access_token	String	Es un String que contiene el Token Bearer que valida el signado del usuario en el ecosistema, a su vez se utiliza para utilizar otros APIs.

Códigos de Respuesta posibles

Código	Título	Descripción
201	Created	El mensaje de la solicitud se ha procesado exitosamente, y ha producido una respuesta. El mensaje de respuesta varía, dependiendo del método de la solicitud y los datos requeridos.
401	InvalidCredentials	Las credenciales proporcionadas no existen en apithy. No repetir la solicitud sin antes modificar las credenciales.
422	Unprocessable entity	La petición estuvo bien formada pero no se pudo procesar debido a errores semánticos. Corrija los parámetros y vuelva a intentar.

Manejo de errores

La API puede producir errores por muchos motivos, como solicitudes fallidas debido a integraciones mal configuradas, parámetros no válidos, errores de autenticación e indisponibilidad de la red.

Ejemplo de respuesta

201:

{

"id": 15900,

"uuid": "4b340a61-c68b-...",

"email": "[email protected]",

"status": {

"id": "2",

"code": "323b99a3-074e-...",

"name": "user_active"

},

"roles": [

{

"id": 5,

"uuid": "318bb5e6-d596-...",

"name": "Estudiante",

"code_name": "student",

"level": 5,

"description": "Acceso de solo estudiante",

"allow_show": true

},

{

"id": 3,

"uuid": "75c7920a-0b00-...",

"name": "Administrador",

"code_name": "administrator",

"level": 3,

"description": "Acceso parcial al sistema de la empresa",

"allow_show": true

}

],

"person": {

"id": 15844,

"uuid": "84b50b5c-b568-...",

"name": "SOPORTE",

"first_name": "APITHY",

"last_name": null,

"full_name": "SOPORTE APITHY",

"avatar": null,

"birthdate": null,

"gender": {

"id": "a97c965b-a9e4-...",

"name": "Otro",

"code_name": "other"

},

"regional_settings": null,

"company": {

"id": 138,

"uuid": "0f6e86a5-e476-...",

"legal_name": "Bice Vida",

"short_name": "BICEVIDA",

"account_name": "bice",

"logo": "company-images/logo-83f07dcd-b204-4767-856c-4d1a92fed1d3.png",

"cover": "company-images/cover-ebbbd0f0-f859-4e96-98d9-3d14d8413093.png",

"customer_id": "cus_MlqJPkSKvKKRAB",

"settings": [],

"regional_settings": {

"id": "78abb3c8-7b69-...",

"created_at": "2023-07-25 18:23:17",

"updated_at": "2023-10-20 16:58:57",

"language": {

"id": "089a726f-...",

"name": "Español de México",

"code": "es-MX"

},

"number_format": {

"id": "3223eb69-...",

"name": "Punto como separador de miles, coma como separador de decimales",

"code": "thousand_dot_decimal_comma",

"thousand": ".",

"decimal": ",",

"fix": 2

},

"date_format": {

"id": "699c7ac5-...",

"name": "dia, mes, año con separador en barra",

"code": "slash_day_month_year",

"format": "dd/MM/yyyy",

"field_order": "DMY"

},

"time_format": {

"id": "e6fe8667-...",

"name": "Format de 12 horas",

"code": "twelve_hour_time",

"format": "hh:mm a",

"is_twenty_four_format": 0

},

"time_zone": {

"id": "3ef2f14b-...",

"name": "(GMT-03:00) Hora estándar de Argentina - Buenos Aires",

"description": "Hora de Buenos Aires",

"time_zone": "America/Argentina/Buenos_Aires",

"weight": 105

}

},

"subscription": {

"id": "367cd798-...",

"name": "Mediana",

"status": "trialing",

"period_end_at": "2024-07-25 16:25:49",

"metadata": {

"lang": "es",

"trial": "0",

"max_users": "500",

"max_storage": "2560"

}

}

}

},

"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e…"

}

401:

{

"name": "InvalidCredentials",

"status": 401,

"message": "Usuario y/o contraseña incorrectos"

}

422:

{

"error": "validation_error",

"errors": {

"email": [

"email should not be empty",

"email must be a string",

"email must be an email"

]

},

"message": "The given data was invalid"

}

{

"error": "validation_error",

"errors": {

"password": [

"password must be a string",

"password should not be empty"

]

},

"message": "The given data was invalid"

}