Agregadores y PSPaaS

Gestión de Usuarios

3min

Con el siguiente conjunto de API's podrán ser gestionados los usuarios que posee un Operador dentro de Suga

Este endpoint permite gestionar el alta de un usuario de la plataforma para poder ser luego asignado dentro de un comercio
POST
Request
Header Parameters
x-api-key
optional
String
API Key del Operador
x-access-token
optional
String
Access Token del Operador
Body Parameters
name
required
String
Nombre y Apellido del usuario
email
required
String
Email del usuario. No se podrá crear más de un usuario con el mismo email
phone
required
String
Teléfono del usuario
identification
required
String
Número de identificación legal del usuario. Para Argentina enviar CUIL. No se podrá crear más de un usuario con el mismo valor de este campo.

Este endpoint permite modificar un usuario previamente dado de alta en el operador
PUT
Request
Path Params
uid
required
String
ID del usuario a editar
Header Parameters
x-api-key
required
String
API Key del Operador
x-access-token
required
String
Access Token del Operador
Body Parameters
name
optional
String
Nombre y Apellido del usuario. Enviar en caso de querer modificar
email
optional
String
Email del usuario. Enviar en caso de querer modificar el email actual.
phone
optional
String
Teléfono del usuario. Enviar en caso de querer modificar.


Los posibles códigos de error al crear o modificar un usuario son: *USER:MISSING_DATA *USER:USER_EXIST_NO_VALID *NDFE -> El {uid} de usuario no corresponde a un usuario válido

Este endpoint permite desactivar un usuario
PUT
Request
Path Params
uid
required
String
ID del usuario a inactivar
Header Parameters
x-api-key
required
String
API Key del Operador
x-access-token
required
String
Access Token del Operador

Este endpoint permite reactivar un usuario previamente inhabilitado
PUT
Request
Path Params
uid
required
String
ID del usuario a re-activar
Header Parameters
x-api-key
required
String
API Key del Operador
x-access-token
required
String
Access Token del Operador

POST
Request
Path Params
action
required
String
Acción a realizar sobre el usuario y la entidad. Valores disponibles: add, remove
Header Parameters
x-api-key
required
String
API Key del Operador.
x-access-token
required
String
Token de acceso del Operador.
x-suga-entity
required
String
ID de la entidad sobre la cual se desea realizar la operación.
Body Parameters
role
optional
String
Rol a asignar al usuario. Solo enviar en caso de alta (add). Valores disponibles: admin
email
required
String
Email del usuario sobre el que se desea ejecutar la acción




Updated 25 Nov 2024
Did this page help you?