Ir para a documentação
SparkGlimDeveloper
Centro de integração com IA
SparkGlimSparkGlim Programadores
Pesquisar em toda a documentação

Experimente um tema na sua língua ou um caminho API exato.

    Navegação da documentação

    Referência API

    Pedir OTP configurado

    Inicia desafio de conta com canal ativo e regista validade e entrega.

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

    Modelo de acesso

    Modelo de acesso
    Sessão SparkGlim e permissões de membro
    Âmbito necessário
    otp:send
    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

    NomeTipoValidação
    AuthorizationObrigatório

    Sessão Bearer SparkGlim existente; associação e capacidades atribuídas autorizam cada operação no servidor.

    		stringValidação: Token Bearer de uma sessão autenticada existente.

    Pedido

    NomeTipoValidação
    channelObrigatório

    Canal de entrega ou integração suportado pela operação e configuração ativa.

    		enumValidação: sms | email | whatsapp.
    recipientObrigatório

    Contacto destinatário de notificação permitida ou desafio de verificação.

    		stringValidação: 3–255.
    purposeObrigatório

    Finalidade de verificação suportada, vinculada à conta e desafio OTP.

    		enumValidação: login | signup | withdrawal_approval | payment_method_verification | campaign_approval.
    memberIdOpcional

    Relação ou revisão existente da conta; propriedade e capacidades são verificadas no servidor.

    		string|nullValidação: UUID.
    metadataOpcional

    Metadados JSON aceites; nunca substituem autorização, preços ou propriedade.

    		objectValidaçã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/otp/send
    http
    POST /api/white-label/portal/reseller/otp/send HTTP/1.1
Host: api.sparkglim.net
Authorization: Bearer <EXISTING_SESSION_TOKEN>
Content-Type: application/json

{
  "channel": "email",
  "recipient": "member@example.com",
  "purpose": "login"
}

    Resposta

    Resposta de sucesso · HTTP 201
    json
    {
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "pending",
    "expiresAt": "2030-01-01T00:10:00.000Z",
    "source": "sms_verification_codes"
  }
}
    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

    Continuar a desenvolver