Referência API

Contexto da conta

Carrega conta aprovada, marca, domínios verificados e contexto configurado para leitura privada.

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

Modelo de acesso

Modelo de acesso: HMAC de Organização no servidor
Âmbito necessário: settings:read
Disponibilidade documentada: Implementado no código

Disponibilidade verificada no código, sem garantia de produção.

A assinatura privada fica no servidor. A API Versão 1 usa assinatura v2; não é uma API v2.

Cabeçalhos

Nome	Tipo	Validação
`x-white-label-domain`Obrigatório Domínio verificado que resolve a conta de Organização aprovada e vincula este pedido.	`string`	Validação: Nome de anfitrião HTTPS verificado.
`x-white-label-key-id`Obrigatório Identificador extraído da chave privada única; nunca envie o segredo neste cabeçalho.	`string`	Validação: Identificador interno da chave privada emitida.
`x-white-label-signature-version`Obrigatório Seleciona a assinatura vinculada ao domínio; as rotas API mantêm a Versão 1.	`string`	Validação: 2.
`x-white-label-timestamp`Obrigatório Instante da assinatura em milissegundos comparado com o relógio do servidor para rejeitar pedidos antigos.	`string`	Validação: Milissegundos com 13 dígitos; dentro de cinco minutos.
`x-white-label-nonce`Obrigatório Valor aleatório novo registado pelo servidor para impedir repetição de um pedido assinado.	`string`	Validação: Valor novo: 16–128 [A-Za-z0-9_-].
`x-white-label-signature`Obrigatório HMAC-SHA256 de domínio, chave de idempotência, credencial de campanha, instante, nonce, método, caminho, consulta ordenada e hash exato do corpo.	`string`	Validação: HMAC-SHA256 hexadecimal em minúsculas.
`x-white-label-campaign-key`Opcional Chave de campanha completa opcional que limita o pedido privado à mesma campanha autorizada.	`string`	Validação: Valor keyId:secret completo, opcional e limitado ao seu âmbito.

Pedido

Os exemplos descrevem o contrato e não são executados. Use registos de teste autorizados; nunca cole segredos reais aqui.

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>

Resposta

Resposta de sucesso · HTTP 200

json

{
  "success": true,
  "data": {
    "account": {
      "status": "enabled"
    },
    "branding": {},
    "domains": [],
    "settings": {},
    "providerSummary": []
  },
  "requestId": "wlapi_example"
}

Resposta de erro · HTTP 400

json

{
  "success": false,
  "error": "<ERROR_MESSAGE>",
  "requestId": "wlapi_example"
}

Validação, permissões, registos indisponíveis e falhas usam estado HTTP e erro do controlador.

Limites e novas tentativas

Organização: 120 pedidos por chave e 300 por IP por janela; respeite Retry-After e X-RateLimit.

Compatibilidade do código

As operações autorizadas exigem testes específicos da conta.

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