TRtrytoku
Customer Portal

Validar Customer Portal Session

Changed on

Indica si una Customer Portal Session sigue sirviendo para entrar al portal.

Devuelve el estado de la sesión y un is_valid que solo es true mientras la sesión está open. Si su expiration_datetime ya pasó, la sesión queda marcada como expired en esta misma llamada y is_valid responde false.

Devuelve también el journey_id de la sesión: el portal ya llama a esta ruta al entrar, así que su SDK de tracking adopta ese journey en vez de acuñar uno propio y los eventos del navegador quedan en el mismo journey que los del backend.

get/v2/customer-portal-sessions/{session_id}/validate

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/v2/customer-portal-sessions/{session_id}/validate
  • Auth
    API key in header x-api-key

Path parameters

session_idstring required

Id de la Customer Portal Session, tal como se devolvió al crearla.

Response

Successful Response

id_sessionstring required
is_validboolean required
journey_idstring

Journey de la sesión, para que el SDK de tracking del portal lo adopte en vez de acuñar uno propio y los eventos del navegador queden en el mismo journey que los del backend. null cuando la sesión no trae ninguno.

state'open' | 'expired' required

Estado de una sesión del portal de pago. Nace open, que es el único estado en que la sesión sirve para entrar al portal, y pasa a expired cuando se cumple su fecha de expiración o cuando se la expira a propósito. Es un cambio de una sola vía: una sesión expirada no vuelve a abrirse.

Changes