Referencia API

Contexto de cuenta

Carga cuenta aprobada, marca, dominios verificados y contexto configurado para lectura privada.

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

Modelo de acceso

Modelo de acceso: HMAC de Organización en el servidor
Permiso requerido: settings: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-id`Obligatorio Identificador 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-version`Obligatorio Selecciona la firma vinculada al dominio; las rutas API siguen en Versión 1.	`string`	Validación: 2.
`x-white-label-timestamp`Obligatorio Momento 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-nonce`Obligatorio Valor 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-signature`Obligatorio HMAC-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-key`Opcional Clave 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

Los ejemplos describen el contrato y no se ejecutan. Use registros de prueba autorizados; nunca pegue secretos reales aquí.

GET /api/white-label/v1/context

http

GET /api/white-label/v1/context 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>

Respuesta

Respuesta correcta · HTTP 200

json

{
  "success": true,
  "data": {
    "account": {
      "status": "enabled"
    },
    "branding": {},
    "domains": [],
    "settings": {},
    "providerSummary": []
  },
  "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