Referência API

Campanhas aprovadas

Lista campanhas aprovadas da organização, limitadas por campaignId. As privadas exigem credencial explícita correspondente.

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

Modelo de acesso

Modelo de acesso: Domínio verificado e chave pública limitada
Âmbito necessário: campaigns: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`Obrigatório Chave pública ou de campanha completa para o âmbito de leitura segura permitido.	`string`	Validação: Chave pública ou de campanha emitida no formato keyId:secret.

Parâmetros

Nome	Tipo	Validação
`campaignId`Opcional Campanha existente na conta e no âmbito mais limitado de qualquer credencial de campanha.	`string`	Validação: UUID dentro do âmbito da chave.

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/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>

Resposta

Resposta de sucesso · HTTP 200

json

{
  "success": true,
  "data": [],
  "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