Colección Postman
Para explorar la API sin escribir código, importa sus rutas en Postman. Hay dos caminos; el primero es el que cubre toda la API.
Usa una clave mk_test_... de una cuenta en modo pruebas: los mensajes se simulan y no se mueve dinero.
Opción 1: importar el documento OpenAPI en vivo
La plataforma publica el documento OpenAPI public-v1 (solo /api/v1/*) en la raíz de tu host:
{BASE}/swagger/public-v1/swagger.json
- En Postman, Import y pega esa dirección como enlace (o descarga el JSON e impórtalo como fichero).
- En la colección creada, pestaña Authorization: tipo Bearer Token con tu clave (
mk_...) o un token OAuth2. - Comprueba que la dirección base de las peticiones es la de tu plataforma.
Como se genera desde el propio servicio, incluye también la API de gestión y se mantiene al día con cada versión. La misma referencia, con visor interactivo, está en {BASE}/docs/api-v1 (ver API pública).
Opción 2: colección ya generada
IncentIA genera la colección incentia-public-v1.postman_collection.json a partir del documento OpenAPI versionado del repositorio. Cada petición está agrupada por etiqueta y la versión de la API va en info.version de la colección. Pídela a tu contacto de IncentIA si la necesitas.
Al importarla, define dos variables de colección:
| Variable | Valor |
|---|---|
baseUrl | La dirección de tu plataforma, sin barra final |
apiKey | Tu clave API (no la compartas ni la subas a un repositorio) |
La colección ya envía Authorization: Bearer {{apiKey}} en todas las peticiones.
El documento versionado en el que se basa esta colección cubre hoy los socios, los movimientos de puntos, el canje de cupones en caja, las evidencias (/api/v1/claims) y el reenvío de webhooks. No incluye programas, niveles, campañas, recompensas, gestión de cupones, sorteos ni atributos de socio: para esos usa la opción 1.