Referência API

Candidatura de fornecedor, voluntário ou parceiro

Guarda candidatura idempotente após verificar módulo, campanha e contactos; enviar não aprova.

POSThttps://api.sparkglim.net/api/white-label/v1/submissions

Modelo de acesso

Modelo de acesso: HMAC de Organização no servidor
Âmbito necessário: submissions:write
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.
`X-Idempotency-Key`Obrigatório Identidade estável de operação reutilizada com os mesmos detalhes; detalhes diferentes com a mesma chave são rejeitados.	`string`	Validação: 16–128 [A-Za-z0-9_-].

Pedido

Nome	Tipo	Validação
`type`Obrigatório Tipo de recurso, reação ou filtro de campanha suportado aqui.	`enum`	Validação: volunteer \| vendor \| partner.
`campaignId`Obrigatório Campanha existente na conta e no âmbito mais limitado de qualquer credencial de campanha.	`string`	Validação: UUID.
`details`Obrigatório Objeto estrito de candidato; só aceita campos documentados.	`object`	Validação: Apenas campos permitidos, sem campos adicionais.
`details.fullName`Obrigatório Identidade ou espaço pedido registado na candidatura de fornecedor, voluntário ou parceiro.	`string`	Validação: 2–120.
`details.email`Obrigatório Email de contacto usado pelo fluxo configurado; por si só não concede acesso.	`string`	Validação: Endereço de e-mail <=254.
`details.phone`Obrigatório Telefone de membro ou candidato usado pelo fluxo existente.	`string`	Validação: Telefone válido <=40.
`details.description`Obrigatório Descrição do organizador que explica campanha ou bilhete.	`string`	Validação: 10–3000.
`details.businessName`Opcional Identidade ou espaço pedido registado na candidatura de fornecedor, voluntário ou parceiro.	`string`	Validação: <=160; obrigatório para vendor/partner.
`details.category`Opcional Categoria de campanha ou definições aprovadas conforme recurso.	`string`	Validação: <=120; obrigatório para volunteer.
`details.stand`Opcional Identidade ou espaço pedido registado na candidatura de fornecedor, voluntário ou parceiro.	`string`	Validação: <=80.
`clientIp`Opcional IP original enviada por servidor autorizado para controlos existentes.	`string`	Validação: Endereço IP válido.

Pedido

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

POST /api/white-label/v1/submissions

http

POST /api/white-label/v1/submissions 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>
X-Idempotency-Key: example_stable_operation_0001
Content-Type: application/json

{
  "type": "volunteer",
  "campaignId": "11111111-1111-4111-8111-111111111111",
  "details": {
    "fullName": "Example applicant",
    "email": "applicant@example.com",
    "phone": "+233200000000",
    "description": "Example application description.",
    "category": "Example configured category"
  }
}

Resposta

Resposta de sucesso · HTTP 201

json

{
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "pending",
    "created_at": "2030-01-01T00:00:00.000Z"
  },
  "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

Modelo de acesso

Cabeçalhos

Pedido

Pedido

Resposta

Limites e novas tentativas

Compatibilidade do código

Continuar a desenvolver