Referencia API
Tipos de entradas
Lista tipos de entrada y moneda tras comprobar módulo y alcance de campaña.
https://api.sparkglim.net/api/white-label/v1/ticket-typesModelo de acceso
- Modelo de acceso
- Dominio verificado y clave pública limitada
- Permiso requerido
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-keyObligatorioClave pública o de campaña completa para el alcance de lectura segura permitido. | string | Validación: Clave pública o de campaña emitida con formato keyId:secret. |
Parámetros
| Nombre | Tipo | Validación |
|---|---|---|
campaignIdOpcionalCampaña existente dentro de la cuenta y del alcance más limitado de la credencial. | string | Validación: UUID dentro del ámbito de la clave. |
Solicitud
Los ejemplos describen el contrato y no se ejecutan. Use registros de prueba autorizados; nunca pegue secretos reales aquí.
GET /api/white-label/v1/ticket-types HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key: <ISSUED_PUBLIC_OR_CAMPAIGN_KEY>
Respuesta
{
"success": true,
"data": [],
"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