Referencia API
Cerrar sesión de entradas
Revoca sesión de entradas del cliente sin cerrar otras cuentas del organizador.
https://api.sparkglim.net/api/white-label/v1/my-tickets/logoutModelo de acceso
- Modelo de acceso
- HMAC de Organización en el servidor
- Permiso requerido
my-tickets:read- Disponibilidad documentada
- Implementado en código
Disponibilidad verificada en el código, sin garantía de producción.
La firma privada permanece en su servidor. La API Versión 1 usa firma v2; no es una API v2.
Encabezados
| Nombre | Tipo | Validación |
|---|---|---|
x-white-label-domainObligatorioDominio verificado que resuelve la cuenta de Organización aprobada y vincula esta solicitud. | string | Validación: Nombre de host HTTPS verificado. |
x-white-label-key-idObligatorioIdentificador extraído de la clave privada única; nunca envíe el secreto en esta cabecera. | string | Validación: Identificador interno de la clave privada emitida. |
x-white-label-signature-versionObligatorioSelecciona la firma vinculada al dominio; las rutas API siguen en Versión 1. | string | Validación: 2. |
x-white-label-timestampObligatorioMomento de firma en milisegundos comparado con el reloj del servidor para rechazar solicitudes caducadas. | string | Validación: Milisegundos de 13 dígitos; dentro de cinco minutos. |
x-white-label-nonceObligatorioValor aleatorio nuevo registrado por el servidor para impedir repetir una solicitud firmada. | string | Validación: Valor nuevo: 16–128 [A-Za-z0-9_-]. |
x-white-label-signatureObligatorioHMAC-SHA256 de dominio, clave de idempotencia, credencial de campaña, instante, nonce, método, ruta, consulta ordenada y hash exacto del cuerpo. | string | Validación: HMAC-SHA256 hexadecimal en minúsculas. |
x-white-label-campaign-keyOpcionalClave de campaña completa opcional que limita la solicitud privada a la misma campaña autorizada. | string | Validación: Valor keyId:secret completo, opcional y limitado a su ámbito. |
Solicitud
| Nombre | Tipo | Validación |
|---|---|---|
campaignIdObligatorioCampaña existente dentro de la cuenta y del alcance más limitado de la credencial. | string | Validación: UUID. |
contactOpcionalCorreo o teléfono del cliente para buscar entradas completadas en la campaña autorizada antes de enviar OTP. | string | Validación: 3–254. |
challengeIdOpcionalIdentificador de solicitud OTP correspondiente, vinculado a contacto, sitio y campaña. | string | Validación: UUID. |
codeOpcionalCredencial o código requerido; nunca publique OTP real o secreto de entrada. | string | Validación: 6 dígitos. |
sessionTokenObligatorioSesión verificada de acceso a entradas vinculada a cuenta, sitio y campaña. | string | Validación: 40–100. |
ticketCodeOpcionalCredencial de entrada existente en campaña autorizada para consulta o admisión. | string | Validación: 6–80. |
pageOpcionalPágina solicitada según numeración documentada; conserve metadatos del servidor. | integer | Validación: 0–1000; valor predeterminado: 0. |
Solicitud
Los ejemplos describen el contrato y no se ejecutan. Use registros de prueba autorizados; nunca pegue secretos reales aquí.
POST /api/white-label/v1/my-tickets/logout HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key-id: <ISSUED_KEY_ID>
x-white-label-signature-version: 2
x-white-label-timestamp: <FRESH_MILLISECONDS>
x-white-label-nonce: <FRESH_SIGNING_NONCE>
x-white-label-signature: <SERVER_GENERATED_SIGNATURE>
Content-Type: application/json
{
"campaignId": "11111111-1111-4111-8111-111111111111",
"sessionToken": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
}Respuesta
{
"success": true,
"data": {
"loggedOut": true
},
"requestId": "wlapi_example"
}{
"success": false,
"error": "<ERROR_MESSAGE>",
"requestId": "wlapi_example"
}Validación, permisos, registros no disponibles y fallos usan el estado HTTP y error del controlador.
Límites y reintentos
Organización: 120 solicitudes por clave y 300 por IP por ventana; respete Retry-After y X-RateLimit.
Compatibilidad del código
Las operaciones autorizadas requieren pruebas específicas de la cuenta.
server/src/api/router.tsserver/src/api/routes/white-label.tsserver/src/white-label/auth.tsserver/src/white-label/schemas.tsserver/src/white-label/organization-service.tsserver/src/white-label/service.ts