API de CDP QA
Colección Postman OpenAPI

API de CDP

Consulta el perfil de tus clientes, crea audiencias y exporta CSV con el token de tu comercio. La consola de abajo envía las peticiones directo a https://apiqa.leal.co.

1 Token Bearer

Todas las operaciones usan el token de acceso de tu comercio en el header Authorization. El token de QA no sirve en PDN y al revés.

Authorization: Bearer <token-de-tu-comercio>

En la consola, abre Authentication y pega el token en Bearer. En Postman, escríbelo en la variable token de la colección. Sin token, el API responde 401: la consola no simula nada.

El commerceId es el identificador numérico de tu comercio. Va en el path de casi todas las operaciones.

2 Tu primera audiencia manual

Una audiencia manual es una lista de uids que tú envías. Este ejemplo aplica solo a ese tipo de audiencia.

POST /v1/crm/api/segmentations/v2/{commerce_id}
{
  "audience_name": "Clientes VIP",
  "audience_type": "manual",
  "uids": ["uid-1", "uid-2"],
  "dry_run": true
}
  • dry_run: true no crea nada: responde 200 con enabled_count y excluded_count, para que revises cuántos clientes entran.
  • Envía dry_run: false (o quítalo) para crear la audiencia. Responde 201 con su segmentation_id.

3 Exportar a CSV

La exportación es asíncrona: primero se encola y después consultas la lista de descargas vigentes. Los tipos públicos son USERS_OF_LIST (clientes de audiencias) y CLIENT (clientes del comercio).

POST /v1/crm/api/exports/new
{
  "idExportType": "USERS_OF_LIST",
  "commerceId": 3,
  "uidCms": "<uid-del-usuario-que-descarga>"
}
GET /v1/crm/api/exports/commerce/{commerce_id}/type/CSV

Devuelve las descargas vigentes con su url, status y fecha de retención.

La colección trae las variables baseUrl, token y commerceId vacías. Solo baseUrl viene con el host de este ambiente. En Postman: Import → Link.