API de verificação por SMS para desenvolvedores: primeiros passos

Se você está testando o fluxo de cadastro do seu aplicativo ou automatizando a verificação, a API permite fazer tudo o que o painel faz, sem precisar abri-lo.

Antes de começar

Obtenha sua chave na página API do seu painel. Não envie a chave para o repositório de código; guarde-a em uma variável de ambiente.

Fluxo básico

1. Consulte a lista de serviços e países.
2. Compre um número.
3. Consulte o status em intervalos ou use um webhook.
4. Conclua a ativação quando o código chegar; cancele se ele não chegar.

Pontos a considerar

• Em novas tentativas, envie o cabeçalho Idempotency-Key. Se você repetir a requisição com a mesma chave após um erro de rede, um segundo número não será comprado.
• Respeite o limite de requisições; não encurte o intervalo de consulta sem necessidade.
• Trate separadamente as respostas de saldo insuficiente e de sem estoque no seu código.

Se o seu software usa o protocolo compatível com o SMS-Activate, você pode se conectar pelos endpoints compatíveis sem alterar seu código. Todos os detalhes estão na documentação da API.