Referência API

Adicionar membro à equipa Criador

Adiciona membro pela equipa Criador e guarda relação de revenda; completa registo normal do organizador.

POSThttps://api.sparkglim.net/api/white-label/portal/reseller/members

Modelo de acesso

Modelo de acesso: Sessão SparkGlim e permissões de membro
Âmbito necessário: members:write
Disponibilidade documentada: Implementado no código

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

Use o fluxo de membros da equipa Criador. A revenda não concede acesso ilimitado à base ou administração.

Cabeçalhos

Nome	Tipo	Validação
`Authorization`Obrigatório Sessão Bearer SparkGlim existente; associação e capacidades atribuídas autorizam cada operação no servidor.	`string`	Validação: Token Bearer de uma sessão autenticada existente.

Pedido

Nome	Tipo	Validação
`userId`Opcional Associação opcional a utilizador existente; não cria conta de criador ilimitada.	`string\|null`	Validação: UUID apenas de um utilizador existente.
`creatorId`Opcional Proprietário autorizado da equipa para a relação de revenda; usa o proprietário configurado por defeito.	`string\|null`	Validação: UUID do proprietário autorizado; criador revendedor por predefinição.
`memberType`Opcional Papel da relação de revenda; capacidades e permissões de equipa aplicam-se separadamente.	`enum`	Validação: owner \| operator \| finance \| support \| sub_creator.
`status`Opcional Estado suportado pedido; aprovação controla publicação e acesso.	`enum`	Validação: invited \| pending \| active \| suspended \| revoked.
`displayName`Opcional Nome apresentado do membro ou contribuinte; não muda propriedade da conta.	`string\|null`	Validação: 2–160.
`email`Opcional Email de contacto usado pelo fluxo configurado; por si só não concede acesso.	`string\|null`	Validação: Endereço de e-mail.
`phone`Opcional Telefone de membro ou candidato usado pelo fluxo existente.	`string\|null`	Validação: 8–40.
`roles`Opcional Papéis de revenda aceites pelo esquema, limitados por permissões do servidor.	`string[]`	Validação: Funções de revendedor suportadas.
`permissions`Opcional Capacidades suportadas pedidas, limitadas pela política da conta e autorização.	`string[]`	Validação: Funcionalidades de revendedor suportadas.
`otpRequired`Opcional Define verificação suportada sem contornar controlos do servidor.	`boolean`	Validação: Valor predefinido: true.
`kycStatus`Opcional Estado de revisão da relação de revenda; não autoriza pagamentos por si só.	`enum`	Validação: not_required \| pending \| verified \| rejected.
`metadata`Opcional Metadados JSON aceites; nunca substituem autorização, preços ou propriedade.	`object`	Validação: Objeto JSON.

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/portal/reseller/members

http

POST /api/white-label/portal/reseller/members HTTP/1.1
Host: api.sparkglim.net
Authorization: Bearer <EXISTING_SESSION_TOKEN>
Content-Type: application/json

{
  "displayName": "Example member",
  "email": "member@example.com",
  "memberType": "sub_creator",
  "roles": [
    "sub_creator"
  ],
  "permissions": []
}

Resposta

Resposta de sucesso · HTTP 201

json

{
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "pending"
  }
}

Resposta de erro · HTTP 400

json

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

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

Limites e novas tentativas

Limite padrão: 100 pedidos por IP em 60 segundos. Aplicam-se também controlos específicos.

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/reseller-service.ts
server/src/white-label/schemas.ts

Modelo de acesso

Cabeçalhos

Pedido

Pedido

Resposta

Limites e novas tentativas

Compatibilidade do código

Continuar a desenvolver