API Reference

Obtener cliente

Ver la Informacion del cliente especificado

OBTENER CLIENTE (GET)

Para obtener la información actual de un Cliente existente, se requiere enviar una petición tipo GET. Se debe agregar al HEADER las credenciales necesarias para acceder al servicio, estas son comercioId y contrasena. Los cuales deberán contener los valores asignados por Operaciones en Línea al momento de generada su Afiliación. Además, en el vínculo del llamado se deberá de agregar el token especifico del CLIENTE que se quiere OBTENER.

  <th style={{ textAlign: "left" }}>
    FORMATO
  </th>

  <th style={{ textAlign: "left" }}>
    RESTRICCIONES
  </th>

  <th style={{ textAlign: "left" }}>
    DESCRIPCION
  </th>
</tr>
  <td style={{ textAlign: "left" }}>
    Numérico
  </td>

  <td style={{ textAlign: "left" }}>
    Admite números sin espacios.
  </td>

  <td style={{ textAlign: "left" }}>
    Identificador del Comercio en OPENLINEA. Es un valor asignado.\ <span style="color:red">(Header)</span>
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    contraseña
  </td>

  <td style={{ textAlign: "left" }}>
    Alfanumérico
  </td>

  <td style={{ textAlign: "left" }}>
    Admite letras y/o números sin espacios. No mayor a 12 caracteres.
  </td>

  <td style={{ textAlign: "left" }}>
    Clave de Acceso a la Terminal Virtual, configurado para su aplicación.\ <span style="color:red">(Header)</span>
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    token
  </td>

  <td style={{ textAlign: "left" }}>
    Alfanumérico
  </td>

  <td style={{ textAlign: "left" }}>
    Admite letras y/o números sin espacio, se permite el uso de guiones (-).
  </td>

  <td style={{ textAlign: "left" }}>
    TOKEN mediante el cual se identifica de forma única al CLIENTE que desea **eliminar**. <span style="color:blue">(PATH)</span>
  </td>
</tr>
VALORES
comercioId

Si el Token existe, el servicio regresa un objeto cliente con la información correspondiente

  <th>
    FORMATO
  </th>

  <th>
    RESTRICCIONES
  </th>

  <th>
    DESCRIPCION
  </th>
</tr>
  <td>
    Alfanumérico
  </td>

  <td>
    Admite letras y/o números de longitud variable
  </td>

  <td>
    TOKEN mediante el cual se identifica de forma única al CLIENTE, este dato es requerido en el caso de operaciones de Actualización, Búsqueda y/o Eliminación de cliente.
  </td>
</tr>

<tr>
  <td>
    id
  </td>

  <td>
    Numérico
  </td>

  <td>
    Admite números sin espacios.
  </td>

  <td>
    ID del comercio
  </td>
</tr>

<tr>
  <td>
    Nombre
  </td>

  <td>
    Alfanumérico
  </td>

  <td>
    Admite letras y/o números. No mayor a 20 caracteres.
  </td>

  <td>
    Nombre del Cliente
  </td>
</tr>

<tr>
  <td>
    apellidos
  </td>

  <td>
    Alfanumérico
  </td>

  <td>
    Admite letras y/o números. No mayor a 20 caracteres.
  </td>

  <td>
    Apellidos del Cliente
  </td>
</tr>

<tr>
  <td>
    calle
  </td>

  <td>
    Alfanumérico
  </td>

  <td>
    Admite letras y/o números. No mayor a 20 caracteres.
  </td>

  <td>
    Dirección del Cliente (se sugiere Calle y Numero)
  </td>
</tr>

<tr>
  <td>
    colonia
  </td>

  <td>
    Alfanumérico
  </td>

  <td>
    Admite letras y/o números. No mayor a 20 caracteres.
  </td>

  <td>
    Dirección del Cliente (se sugiere cualquier referencia que ayude a ubicar la dirección del Cliente)
  </td>
</tr>

<tr>
  <td>
    ciudad
  </td>

  <td>
    Alfanumérico
  </td>

  <td>
    Admite letras y/o números. No mayor a 20 caracteres.
  </td>

  <td>
    Ciudad
  </td>
</tr>

<tr>
  <td>
    estado
  </td>

  <td>
    Alfanumérico
  </td>

  <td>
    Admite letras y/o números. No mayor a 20 caracteres.
  </td>

  <td>
    Estado
  </td>
</tr>

<tr>
  <td>
    estadoId
  </td>

  <td>
    Alfanumérico
  </td>

  <td>
    Admite letras. Solo debe contener 2 caracteres
  </td>

  <td>
    Estado del Tarjetahabiente\
    Ejemplo: Nuevo León = NL\
    [Anexo 2 - Código de Estados para México](https://bloomin.readme.io/reference/codigo-de-estados)
  </td>
</tr>

<tr>
  <td>
    pais
  </td>

  <td>
    Alfanumérico
  </td>

  <td>
    Admite letras y/o números. No mayor a 20 caracteres.
  </td>

  <td>
    País
  </td>
</tr>

<tr>
  <td>
    paisId
  </td>

  <td>
    Alfanumérico
  </td>

  <td>
    Admite letras. Solo debe contener 2 caracteres
  </td>

  <td>
    País de Tarjetahabiente\
    Ejemplo: México = MX\
    Anexo 1 - Código de Países  

    [Anexo 1 - Código de Países](https://bloomin.readme.io/reference/codigo-de-paises)
  </td>
</tr>

<tr>
  <td>
    codigoPostal
  </td>

  <td>
    Numérico
  </td>

  <td>
    Admite números sin espacios.
  </td>

  <td>
    Código Postal
  </td>
</tr>

<tr>
  <td>
    email
  </td>

  <td>
    Alfanumérico
  </td>

  <td>
    Admite letras y/o números sin espacios, se permiten los símbolos de arroba (), punto (.) y guiones (-), (\_). No mayor a 20 caracteres
  </td>

  <td>
    Dirección de Correo Electrónico para el envío de Notificaciones.
  </td>
</tr>

<tr>
  <td>
    telefono
  </td>

  <td>
    Alfanumérico
  </td>

  <td>
    Admite letras y/o números, se permiten los símbolos de paréntesis, corchetes y guiones.
  </td>

  <td>
    Número Telefónico
  </td>
</tr>

<tr>
  <td>
    estatus
  </td>

  <td>
    Numérico
  </td>

  <td>
    Admite números sin espacios.
  </td>

  <td>
    Estatus de errores
  </td>
</tr>

<tr>
  <td>
    fechaAlta
  </td>

  <td>
    Alfanumérico
  </td>

  <td>
    Admite letras y/o números de longitud variable
  </td>

  <td>
    Fecha exacta en la cual se creó el cliente
  </td>
</tr>
VARIABLE
token

📘

Obtener Cliente Desarrollo

https://servertest.operacionesenlinea.com/OpenLineaRestAPI/api/clientes/{token}

📘

Obtener Cliente Produccion

https://servidorseguro.operacionesenlinea.com/OpenLineaRestAPI/api/clientes/{token}