Resumen de la API de Customer Journey

La API de Customer Journey permite a un backend gestionar Customer Journeys de forma programática: crear y editar definiciones de journeys, mover journeys a través de su ciclo de vida (iniciar, pausar, finalizar, borrador, archivar), activar un journey en ejecución desde sus propios sistemas y obtener estadísticas por journey.

Es la misma API que utiliza el creador de Customer Journey, expuesta sobre REST/JSON a través de un puente gRPC-Gateway.

URL base

Los métodos de gRPC-Gateway y los métodos externos heredados se sirven en diferentes hosts:

Métodos	URL base
gRPC-Gateway: `/api/v3/journeygateway/...` (ciclo de vida, crear, actualizar)	`https://journey-api.svc-nue.pushwoosh.com`
Externo heredado: `/api/journey/...` (iniciar por API, estadísticas, eliminar usuarios)	`https://journey.pushwoosh.com`

Autenticación

Cada solicitud debe incluir un encabezado Authorization con un token de acceso a la API de Pushwoosh del lado del servidor:

Authorization: Api SU_TOKEN_API

Métodos

Gestionar journeys

Ciclo de vida: POST /api/v3/journeygateway/{action}. Iniciar, pausar, finalizar, poner en borrador o archivar un journey por su UUID.
Crear y actualizar: POST /api/v3/journeygateway y PUT /api/v3/journeygateway/{uuid}. Crear una nueva definición de journey o reemplazar una existente.

Activar journeys

Iniciar por API: POST /api/journey/{id}/start/external. Inyectar usuarios en el punto de entrada de la API de un journey que ya está en ejecución.

Estadísticas y audiencia

Obtener estadísticas del Journey: GET /api/journey/{id}/statistics/external. Métricas de entrega y conversión por punto.
Eliminar usuarios de journeys: POST /api/journey/drop-users/external. Eliminar usuarios de todos o de journeys activos seleccionados.

Referencia

Objeto Journey: la forma de la definición del journey (info, params, points, comments) devuelta por los métodos de ciclo de vida, creación y actualización.
Referencia de puntos: la estructura point_data para cada tipo de punto: elementos de entrada, tiempo, división, acción y mensajería.

Inicio del ciclo de vida vs. Iniciar por API

Customer Journey tiene dos operaciones que suenan similares pero se comportan de manera diferente.

El inicio del ciclo de vida cambia el estado del journey (por ejemplo, de Borrador a En ejecución). Iniciar por API inyecta usuarios en un journey que ya está en ejecución. La siguiente tabla los compara lado a lado.

	Inicio del ciclo de vida	Iniciar por API
Endpoint	`POST /api/v3/journeygateway/start`	`POST /api/journey/{id}/start/external`
Qué hace	Activa el journey y lo mueve al estado En ejecución	Inyecta usuarios en el punto de entrada de la API de un journey que ya está en ejecución
Estado del journey requerido	Borrador o Pausado	En ejecución (con un punto de Inicio de API)
Frecuencia de ejecución	Una vez por cambio de estado	Repetidamente, según los usuarios necesiten entrar

Formato de solicitud y respuesta

Tipo de contenido: application/json.
Los nombres de los campos de v3 utilizan snake_case. Los valores de enumeración se serializan como sus nombres de cadena (por ejemplo, "STATUS_RUNNING", "POINT_TYPE_SEND_PUSH").
Los métodos de gRPC-Gateway (/api/v3/journeygateway/...) devuelven el objeto journey en caso de éxito y el sobre de error estándar de gRPC-Gateway en caso de fallo: { "code": ..., "message": ..., "details": [...] }.
Los métodos externos heredados (/api/journey/...) devuelven un cuerpo JSON específico del método en caso de éxito y { "success": false, "message": ... } con HTTP 400 en errores de validación.

Inicio rápido

curl -X POST https://journey-api.svc-nue.pushwoosh.com/api/v3/journeygateway/start \
  -H "Authorization: Api SU_TOKEN_API" \
  -H "Content-Type: application/json" \
  -d '{ "uuid": "11111111-2222-3333-4444-555555555555" }'

Próximos pasos

Ciclo de vida

Crear y actualizar

Iniciar por API

Obtener estadísticas del Journey

Eliminar usuarios de journeys

Objeto Journey

Referencia de puntos