Consulta de cliente

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

---

Endpoint

• Método: GET

URL del endpoint

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

Importante

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

Consejo de integración: recuperar un ID

La API de XGate utiliza el campo name como clave de validación para los clientes. Si pierde el _id de un usuario, envíe una solicitud de Crear cliente con el mismo nombre. El servidor detectará el nombre existente y devolverá un error amigable que incluirá el _id del registro existente, lo que le permitirá actualizar su base de datos interna.

---

Prueba de integración

Simule la creación de un cliente ahora. El resultado mostrará el _id generado.

🔍

Probar: Consultar Cliente

1. Tus Credenciales (Admin)

Tu Correo

Tu Contraseña

---

2. Datos de Consulta

ID de Cliente (_id)

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

---

Solicitud

Encabezados obligatorios

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

---

Respuestas

Éxito (200 OK)

Se encontraron los datos del cliente.

{
  "_id": "697e15******************",
  "name": "Client Name",
  "email": "email@domain.com",
  "document": "123********",
  "version": 1,
  "createdDate": "202****************",
  "updatedDate": "202****************"
}

Errores comunes

Estado	Mensaje	Posible motivo
401	Unauthorized	• Token inválido o vencido. • Encabezado faltante o inválido. • IP no permitido. • No tiene autorización para realizar esta acción.
404	Not Found	• El ID proporcionado no es válido. El cliente no existe.
500	Internal Server Error	Error interno del servidor. Contacte con soporte.

---

Cómo usar

La ruta de consulta del cliente es un endpoint de solo lectura. Utilícela para recuperar y verificar los datos actuales de un usuario ya registrado en su base de datos de XGate.

Casos de uso comunes

A diferencia de las rutas de pago, no hay un flujo complejo aquí. Utilice este endpoint principalmente para:

1. Auditoría y verificación: Confirmar que el document (CPF/CNPJ) o el email vinculados al cliente sean correctos.
2. Validación previa a la actualización: Obtener los datos actuales de registro del usuario para completar previamente una pantalla de "Editar perfil" en su frontend.
3. Sincronización de base de datos: Asegurarse de que su base de datos interna permanezca actualizada y sincronizada con XGate.

Ejemplo práctico

El propósito principal es ver datos de forma rápida y segura. Al solicitar el cliente usando su _id, recibirá el objeto completo del cliente.

1. Lo que recibe al consultar el cliente:

Observe en el ejemplo siguiente cómo la ruta devuelve la información vital, lo que le permite verificar el document (línea resaltada):

{
  "_id": "697e15******************",
  "name": "Client Name",
  "email": "email@domain.com",
  "document": "123********",
  "version": 1,
  "createdDate": "202****************",
  "updatedDate": "202****************"
}

---

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 = "***********";

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