API Usuarios

API para gestionar los usuarios cliente de una cuenta y también se pueden administrar los timbres de una cuenta.

Ambiente de Pruebas

https://api.test.sw.com.mx/management/api/users

Url Productivo:

https://api.sw.com.mx/management/api/users

Obtener Usuarios

Endpoint

MétodoRuta
GET/management/api/users

Autenticación y Headers

AuthorizationBearer Token

Ejemplo Request

Crear Usuario

Endpoint

MétodoRuta
POST/management/api/users

Autenticación y Headers

AuthorizationBearer Token
Content-Typeapplication/json

Parámetros JSON

PropiedadTipoUsoDescripción
emailstring Requerido Correo del usuario
passwordstring Requerido Contraseña del usuario
namestring Requerido Nombre del usuario
rfcstring Requerido RFC del usuario
profileint Requerido (Default = 3) Tipo de perfil del usuario
stampsint Opcional Timbres a asignar en la creación
unlimitedbool Requerido Especificar si tendrá timbres ilimitados
activebool Requerido (Default = true) Estatus del usuario

Ejemplo Request

Actualizar Usuario

Endpoint

MétodoRuta
PUT/management/api/users/{idUser}

Autenticación y Headers

AuthorizationBearer Token
Content-Typeapplication/json

Parámetros Path

PropiedadUsoDescripción
idUserRequeridoUUID del usuario a actualizar

Parámetros JSON

PropiedadTipoUsoDescripción
namestringOpcionalNombre del usuario
rfcstringOpcionalRFC del usuario
passwordstringOpcionalContraseña del usuario
unlimitedboolOpcionalEspecificar si tendrá timbres ilimitados
activeboolOpcionalEstatus del usuario

Ejemplo Request

Eliminar Usuario

MétodoRuta
DELETE/management/api/users/{idUser}

Autenticación y Headers

AuthorizationBearer Token
Content-Typeapplication/json

Parámetros Path

PropiedadUsoDescripción
idUserRequeridoUUID del usuario a eliminar

Ejemplo Request

Obtener Timbres

MétodoRuta
GET/management/api/balance

Autenticación y Headers

AuthorizationBearer Token

Ejemplo Request

Agregar Timbres

MétodoRuta
POST/management/api/balance/{idUser}/add/{stamps}
Authorization Bearer Token
Content-Typeapplication/json

Parámetros Path

PropiedadUsoDescripción
idUserRequeridoUUID del usuario
stampsRequeridoCantidad de timbres a agregar

Parámetros JSON

PropiedadUsoDescripción
comentarioOpcionalComentario agregado al movimiento

Ejemplo Request

Eliminar Timbres

Endpoint

MétodoRuta
POST/management/api/balance/{idUser}/remove/{stamps}
Authorization Bearer Token
Content-Typeapplication/json

Parámetros Path

PropiedadUsoDescripción
idUserRequeridoUUID del usuario
stampsRequeridoCantidad de timbres a eliminar

Parámetros JSON

PropiedadUsoDescripción
comentarioOpcionalComentario agregado al movimiento

Ejemplo Request

Updated on enero 6, 2022

Was this article helpful?

Related Articles