Agregar usuario

Agregue nuevos miembros a su comercio. Utilice esta funcionalidad para incorporar usuarios con roles específicos o privilegios dentro de Trazo. Asegúrate de proporcionar la información necesaria sobre cada nuevo miembro para garantizar una integración fluida y segura de los nuevos usuarios en el sistema.

Ruta

POST /v1/merchant/team

Encabezado

Name	Value
Content-Type*	application/json
x-auth-token*	{token}

Cuerpo

Name	Type	Description
phone	string	Número de celular del usuario (incluir el código de área del país). Obligatorio en caso de que email se encuentre vacío. Ejemplo: 573112223333
email	string	Correo del usuario. Obligatorio en caso de que phone se encuentre vacío. Ejemplo: [email protected]
nickname	string	Es el nombre con el que nos comunicaremos con el usuario, por ejemplo ¡Hola Carlos! Por defecto es el mismo first_name. Ejemplo: Carlos
first_name*	string	Nombres del usuario. Se usan para la validación del número de documento. Ejemplo: Carlos Andrés
last_name	string	Son los apellidos del usuario. Ejemplo: Martínez Barrios
user_id_type*	string	Tipo de documento de identificación del usuario. CC | CE | NIT | PASAPORTE | DNI | EIN
user_id_number*	string	Número del documento de identificación del usuario. Ejemplo: 11119999
user_id_number_dv	string	Dígito de verificación del número de identificación del usuario. Aplica únicamente para NIT. Ejemplo: 9
role*	string	Define el rol que tendrá el usuario dentro de Trazo. collector | member | analyst | specialist
collect_limit	numeric	Valor máximo autorizado para recaudar por el usuario en efectivo. Ejemplo: 2000000
external_user_id	string	Identificador asignado para el usuario. Ejemplo: KFF122

Respuesta

200

{
    "message": "The user has been successfully created.",
    "created_at": "2024-08-27T13:48:50+00:00"
}

400

{
    "error": "The provided phone number is not valid or already registered in the system."
}

401

{
    "status": "unauthorized",
    "code": "Q103",
    "error": "El x-auth-token se encuentra vencido. Por favor genera un nuevo token y reintenta de nuevo el cobro."
}

---

Ejemplo

cURL

curl --location --request POST '{{base_url}}/v1/merchant/team' \
--header 'x-auth-token: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone": "",
    "email": "",
    "nickname": "",
    "first_name": "",
    "last_name": "",
    "user_id_type": "",
    "user_id_number": "",
    "user_id_number_dv": "",
    "role": "",
    "collect_limit": "",
    "user_country": "",
    "user_state": "",
    "user_city": ""
}'

NodeJS (Axios)

var axios = require('axios');
var data = JSON.stringify({
  "phone": "",
  "email": "",
  "nickname": "",
  "first_name": "",
  "last_name": "",
  "user_id_type": "",
  "user_id_number": "",
  "user_id_number_dv": "",
  "role": "",
  "collect_limit": "",
  "user_country": "",
  "user_state": "",
  "user_city": ""
});

var config = {
  method: 'post',
  url: `${base_url}/v1/merchant/team`,
  headers: { 
    'x-auth-token': token, //Agregar token
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Python

import requests
import json

url = f"{base_url}/v1/merchant/team"

payload = json.dumps({
  "phone": "",
  "email": "",
  "nickname": "",
  "first_name": "",
  "last_name": "",
  "user_id_type": "",
  "user_id_number": "",
  "user_id_number_dv": "",
  "role": "",
  "collect_limit": "",
  "user_country": "",
  "user_state": "",
  "user_city": ""
})
headers = {
  'x-auth-token': token, #Agregar token
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)