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
String
optional
API Key del Operador
x-access-token
String
optional
Access Token del Operador
Body Parameters
name
String
required
Nombre y Apellido del usuario
email
String
required
Email del usuario. No se podrá crear más de un usuario con el mismo email
phone
String
required
Teléfono del usuario
identification
String
required
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
String
required
ID del usuario a editar
Header Parameters
x-api-key
String
required
API Key del Operador
x-access-token
String
required
Access Token del Operador
Body Parameters
name
String
optional
Nombre y Apellido del usuario. Enviar en caso de querer modificar
email
String
optional
Email del usuario. Enviar en caso de querer modificar el email actual.
phone
String
optional
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
String
required
ID del usuario a inactivar
Header Parameters
x-api-key
String
required
API Key del Operador
x-access-token
String
required
Access Token del Operador
Este endpoint permite reactivar un usuario previamente inhabilitado
PUT
Request
Path Params
uid
String
required
ID del usuario a re-activar
Header Parameters
x-api-key
String
required
API Key del Operador
x-access-token
String
required
Access Token del Operador
POST
Request
Path Params
action
String
required
Acción a realizar sobre el usuario y la entidad. Valores disponibles: add, remove
Header Parameters
x-api-key
String
required
API Key del Operador.
x-access-token
String
required
Token de acceso del Operador.
x-suga-entity
String
required
ID de la entidad sobre la cual se desea realizar la operación.
Body Parameters
role
String
optional
Rol a asignar al usuario. Solo enviar en caso de alta (add). Valores disponibles: admin
email
String
required
Email del usuario sobre el que se desea ejecutar la acción