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étodo	Ruta
GET	/management/api/users

Autenticación y Headers

Authorization

Bearer Token

Ejemplo Request

curl --request GET \

--url https://api.test.sw.com.mx/management/api/users \

--header 'Authorization: Bearer $token'

Probar en Postman

Crear Usuario

Endpoint

Método	Ruta
POST	/management/api/users

Autenticación y Headers

Authorization	Bearer Token
Content-Type	application/json

Parámetros JSON

Propiedad	Tipo	Uso	Descripción
email	string	Requerido	Correo del usuario
password	string	Requerido	Contraseña del usuario
name	string	Requerido	Nombre del usuario
rfc	string	Requerido	RFC del usuario
profile	int	Requerido	(Default = 3) Tipo de perfil del usuario
stamps	int	Opcional	Timbres a asignar en la creación
unlimited	bool	Requerido	Especificar si tendrá timbres ilimitados
active	bool	Requerido	(Default = true) Estatus del usuario

Ejemplo Request

curl --request POST \

--url https://api.test.sw.com.mx/management/api/users \

--header 'Authorization: Bearer $token' \

--header 'Content-Type: application/json' \

--data '{

"Email": "sw@test.mx",

"Password": "1q2w3e4r",

"Name": "SW SW SW",

"RFC": "XAXX110101111",

"Profile": 3,

"Stamps": 20,

"Unlimited": false,

"Active": true

Probar en Postman

Actualizar Usuario

Endpoint

Método	Ruta
PUT	/management/api/users/{idUser}

Autenticación y Headers

Authorization	Bearer Token
Content-Type	application/json

Parámetros Path

Propiedad	Uso	Descripción
idUser	Requerido	UUID del usuario a actualizar

Parámetros JSON

Propiedad	Tipo	Uso	Descripción
name	string	Opcional	Nombre del usuario
rfc	string	Opcional	RFC del usuario
unlimited	bool	Opcional	Especificar si tendrá timbres ilimitados
active	bool	Opcional	Estatus del usuario

Ejemplo Request

curl --request PUT \

--url https://api.test.sw.com.mx/management/api/users/af331caa-2437-498c-b700-5a273d1f39e6 \

--header 'Authorization: Bearer $token' \

--header 'Content-Type: application/json' \

--data '{

"Name": "SW SAPIEN",

"Rfc": "CACX7605101P8",

"Unlimited": false,

"active": true

Probar en Postman

Eliminar Usuario

Método	Ruta
DELETE	/management/api/users/{idUser}

Autenticación y Headers

Authorization	Bearer Token
Content-Type	application/json

Parámetros Path

Propiedad	Uso	Descripción
idUser	Requerido	UUID del usuario a eliminar

Ejemplo Request

curl --request DELETE \

--url https://api.test.sw.com.mx/management/api/users/b8ac2a9a-a4c4-4782-a947-088c30c2488a \

--header 'Authorization: Bearer $token'

Probar en Postman

Obtener Timbres

Método	Ruta
GET	/management/api/balance

Autenticación y Headers

Authorization

Bearer Token

Ejemplo Request

curl --request GET \

--url https://api.test.sw.com.mx/management/api/balance \

--header 'Authorization: Bearer $token'

Probar en Postman

Agregar Timbres

Método	Ruta
POST	/management/api/balance/{idUser}/add/{stamps}

Authorization	Bearer Token
Content-Type	application/json

Parámetros Path

Propiedad	Uso	Descripción
idUser	Requerido	UUID del usuario
stamps	Requerido	Cantidad de timbres a agregar

Parámetros JSON

Propiedad	Uso	Descripción
comentario	Opcional	Comentario agregado al movimiento

Ejemplo Request

curl --request POST \

--url https://api.test.sw.com.mx/management/api/balance/c8783197-c4b6-4bee-b829-1e478f3d349b/add/20 \

--header 'Authorization: Bearer $token' \

--header 'Content-Type: application/json' \

--data '{

"Comentario": "Compra de timbres"

Probar en Postman

Eliminar Timbres

Endpoint

Método	Ruta
POST	/management/api/balance/{idUser}/remove/{stamps}

Authorization	Bearer Token
Content-Type	application/json

Parámetros Path

Propiedad	Uso	Descripción
idUser	Requerido	UUID del usuario
stamps	Requerido	Cantidad de timbres a eliminar

Parámetros JSON

Propiedad	Uso	Descripción
comentario	Opcional	Comentario agregado al movimiento

Ejemplo Request

curl --request POST \

--url https://api.test.sw.com.mx/management/api/balance/c8783197-c4b6-4bee-b829-1e478f3d349b/remove/2193 \

--header 'Authorization: Bearer $token' \

--header 'Content-Type: application/json' \

--data '{

"Comentario": "Se eliminan timbres agregados por error"

Probar en Postman

Updated on junio 10, 2022

Was this article helpful?

Yes No

Obtener Usuarios

Crear Usuario

Actualizar Usuario

Eliminar Usuario

Obtener Timbres

Agregar Timbres

Eliminar Timbres

Was this article helpful?

Related Articles