Recepção de SMS OTP · Pagamentos em cripto
Centro de ajudaDocumentação da API
SmsVeo.
Criar conta
DOCUMENTAÇÃO TÉCNICA

API SMS: catálogo, ativações e integração backend

Arquitetura do módulo SmsVeo, estados de ativação e contrato de integração. A integração do provedor ainda será implementada.

Separe catálogo público de recepção privada

Dados públicos descrevem serviço, país, preço e duração. Não contêm número de telefone ou código alocado. Ativações pertencem a uma conta e pedido com rastreamento privado separado.

O diretório de serviço e país é separado das ofertas comerciais. O contrato de integração requer um catálogo API com preço e disponibilidade autoritativos para pedidos.

Catálogo e pedidos

O contrato existente especifica GET /catalog/products e GET /catalog/products/:slug. O backend fornece preço, duração e disponibilidade explícita autoritativos; estoque ausente permanece desconhecido.

Pedidos enviam um identificador de produto com uma chave de idempotência. O servidor verifica preço e estoque antes da reserva ou alocação. Ler uma página não aciona ações sensíveis.

Estados de recepção

O módulo distingue alocação, espera, recebido, concluído, cancelado, expirado e falha. A alocação pode estar pendente sem um número; espera real e recepção exigem o número e validade do backend.

Cada mensagem tem um identificador estável, carimbo de data/hora e texto. O backend pode fornecer um código extraído; a interface não deve adivinhar um OTP. O diretório público não contém número de telefone alocado nem código privado.

Ações autorizadas e atualizações

GET /activations e GET /activations/:id são leituras privadas. POST /activations/:id/actions envia cancelar, finalizar ou reenviar com uma chave de idempotência. O backend anuncia e reavalia ações permitidas.

Leituras privadas usam a sessão, idioma da interface e cache adequado. Intervalos de rastreamento seguem o contrato; expiração do servidor e estado têm prioridade sobre um temporizador do navegador.

Segredos de pagamento, alocação e provedor

A fatura fixa ativo, rede, valor, endereço e validade. Confirmação de pagamento e alocação de número são eventos separados. O backend lida com falhas e tentativas sem alocação dupla.

Chaves de provedor e segredos de pagamento permanecem no servidor. A API autoriza cada leitura de conta, define retenção de mensagens e mantém identificadores internos de provedor privados. Esta página documenta o contrato de integração e não anuncia uma API pública operacional.

Referência do endpoint do contrato

MétodoEndpointFunção
GET/catalog/productsCatálogo público
GET/activationsAtivações de conta
GET/activations/:idRastreamento privado de recepção
POST/activations/:id/actionsAção autorizada

Estes são os caminhos de contrato frontend existentes, não endpoints de produção publicados. Provedor, autenticação e integração de pagamento ainda precisam ser conectados.

Abrir o catálogoExplore todos os guias