Referencia API

Campañas aprobadas

Lista campañas aprobadas de la organización, limitadas por campaignId. Las privadas requieren credencial explícita coincidente.

GEThttps://api.sparkglim.net/api/white-label/v1/campaigns

Modelo de acceso

Modelo de acceso: Dominio verificado y clave pública limitada
Permiso requerido: campaigns: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-domain`Obligatorio Dominio 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`Obligatorio Clave 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
`campaignId`Opcional Campañ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/campaigns

http

GET /api/white-label/v1/campaigns HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key: <ISSUED_PUBLIC_OR_CAMPAIGN_KEY>

Respuesta

Respuesta correcta · HTTP 200

json

{
  "success": true,
  "data": [],
  "requestId": "wlapi_example"
}

Respuesta de error · HTTP 400

json

{
  "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.ts
server/src/api/routes/white-label.ts
server/src/white-label/auth.ts
server/src/white-label/schemas.ts
server/src/white-label/organization-service.ts
server/src/white-label/service.ts