Actualizar cliente

Este endpoint permite actualizar el registro de cliente en la base de datos de XGate.

---

Endpoint

• Método: PUT

URL del endpoint

https://api.xgateglobal.com/customer/CUSTOMER_ID

Importante

El valor CUSTOMER_ID hace referencia al _id devuelto al crear un cliente.

---

Prueba de integración

Simule la actualización de un cliente ahora.

🔄

Probar: Actualizar Cliente

1. Sus Credenciales (Admin)

Su Correo

Su Contraseña

---

2. ¿Qué cliente desea cambiar?

ID del Cliente (_id)

¿No tienes un cliente? Haz clic aquí para crear

---

3. Nuevos Datos de Registro

Nuevo Nombre Completo

Documento (CPF/CNPJ)

Correo (Opcional)

Teléfono (Opcional)

---

Solicitud

Encabezados obligatorios

Encabezado	Valor	Descripción
Authorization	Bearer <tu_token>	Token de autenticación JWT.

Cuerpo de la solicitud

Campo	Tipo	Obligatorio	Descripción
name	string	Sí	Nombre completo del cliente.
document	string	Sí	CPF o CNPJ.
email	string	No	Correo electrónico del cliente para notificaciones.
phone	string	No	Número de teléfono del cliente.

---

Respuestas

Éxito (200 OK)

Los datos del cliente se actualizaron correctamente.

{
    "message":"Cliente alterado com sucesso"
}

Errores comunes

Estado	Mensaje	Posible motivo
400	Bad Request	Se requiere el nombre y/o documento del cliente.
401	Unauthorized	• Token inválido o vencido. • Encabezado faltante o inválido. • IP no permitido. • No tiene autorización para realizar esta acción.
409	Conflict	• El nombre proporcionado ya está registrado. • El documento proporcionado ya está registrado.
500	Internal Server Error	Error interno del servidor. Contacte con soporte.

---

Cómo usar

La ruta de actualización del cliente es un endpoint de modificación de datos. Permite cambiar la información de registro de un usuario que ya existe en su base de datos de XGate.

Casos de uso comunes

Utilice este endpoint principalmente en escenarios de mantenimiento de cuentas de usuario:

1. Corrección de datos: Corregir errores tipográficos en name o corregir el document (CPF/CNPJ) si el usuario lo proporcionó incorrectamente durante el registro.
2. Actualización de contacto: Modificar el email o el phone del cliente únicamente con fines de notificación y comunicación, manteniendo actualizados los datos de contacto administrativos.
3. Sincronización de perfil: Asegurarse de que, cuando el cliente actualice los datos de perfil en su aplicación o sitio, el cambio se refleje automáticamente en el ecosistema de XGate.

Ejemplo práctico

El propósito principal de esta ruta es aplicar cambios y confirmar el éxito de la operación sin devolver grandes volúmenes de datos. Al solicitar la actualización con el _id del cliente en la URL y enviar la nueva información en el cuerpo, la API procesará el cambio y devolverá una simple confirmación.

1. Lo que recibe cuando se actualiza el cliente correctamente:

{
    "message":"Cliente alterado com sucesso"
}

---

Integración

Node.js

El ejemplo de integración utiliza la librería Axios en Node.js.

Instalando Axios:

npm install axios

Ejemplo en JavaScript:

const axios = require("axios");

(async () => {
    const email = "your_email@domain.com";
    const password = "**********";
    const customerId = "***********";
    const customer = {
        name: "Name client",
        phone: "119*******",
        email: "your_email@domain.com",
        document: "000000*******"
    }

    try {
        const url_api = "https://api.xgateglobal.com"
        const login = await axios.post(`${url_api}/auth/token`, { email, password });
        const { data } = await axios.put(`${url_api}/customer/${customerId}`, customer, {
            headers: {
                "Authorization": `Bearer ${login.data.token}`
            }
        });
        console.log(data); // Respuesta
    } catch (error) {
        console.log(error.response.data.message) // Error
    }
})()