Introducción

APIs públicas de Clau.io para POS, Registro y Ecommerce.

Las APIs públicas de Clau.io permiten integrar tu punto de venta, tu flujo de registro de clientes y tu ecommerce con la plataforma de fidelización.

Esta documentación cubre el tenant APPID 1.

Grupos de APIs

Base URL

AmbienteURL
Pruebashttps://apidev2.clau.io
Producciónhttps://api3.clau.io

Los ejemplos de esta documentación apuntan al ambiente de Pruebas y usan el cliente de prueba de abajo.

Datos de prueba

Cliente ya registrado en Pruebas (APPID 1) para probar los endpoints de consulta:

CampoValor
Correo[email protected]
Cédula (numId)10002000
Teléfono10002000

Autenticación

Todas las llamadas requieren estos headers:

HeaderValor
apikeyPOS-yv#bt8UGkHiD9hR$Uo^0m6Ark69261MTL7kEO@M226A0
APPID1
Content-Typeapplication/json

Ver Autenticación para más detalles.

Primera llamada

Consultar un cliente por correo:

curl -X POST 'https://apidev2.clau.io/pos/v3/consultar_usuario' \
  -H 'apikey: POS-yv#bt8UGkHiD9hR$Uo^0m6Ark69261MTL7kEO@M226A0' \
  -H 'APPID: 1' \
  -H 'Content-Type: application/json' \
  -d '{ "cliente": { "email": "[email protected]" } }'

Respuesta:

{
  "codigoRespuesta": 0,
  "msj": "EXITO",
  "data": [ { "userId": "abc123", "nombre": "Luis", "email": "[email protected]", "numId": "1000200", "telefono": "10002000", "puntos": 15000 } ]
}

Formato de respuesta

El envelope estándar es:

{ "codigoRespuesta": 0, "msj": "Exito", "data": {} }

codigoRespuesta: 0 es el único código de éxito; cualquier otro valor es error (ver msj). Algunos endpoints usan un envelope legado CodRes / Msj / ArrRes — está indicado en cada endpoint. Ver Códigos de respuesta.