SIMUB

SIMUB activation API

Integrate SIMUB SMS and temporary mail activations with documented authentication, lifecycle, error handling and safe server-side examples.

Authentication and endpoint choice

Protected requests use the API key associated with your verified SIMUB account. Send it only over HTTPS and keep it in a server-side secret store or environment variable; never embed it in client code, a public repository or a screenshot. The SMSHub-compatible handler receives action as a parameter, while SIMUB SMS routes put it in the path. Choose one interface and parse its documented response format.

  • Use /stubs/handler_api.php for an existing SMSHub-style client that sends action, api_key and action-specific parameters.
  • Use /api/sms/{action} when a direct SIMUB SMS route better fits your server application.
  • Use the dedicated /api/mail endpoints for temporary mail; SMS activation identifiers and mail identifiers are separate.

Discover services, countries, prices and balance first

Call getBalance for available funds, getServices or getServicesList for current service codes, and getCountries for supported country codes. Choose getPrices, getPricesV2 or getPricesV3 for the response shape your integration expects. Catalogs, counts and prices are provider snapshots: cache them briefly, display the returned price when relevant and revalidate before purchase. Never invent a code from a visible label.

Core SMS activation lifecycle

A purchase and a status check are different operations. Persist the activation identifier immediately so an application timeout does not lose a reserved number.

  • Select a documented service and country, inspect current price and stock, then call getNumber, getNumberV2 or getNumberV3 once.
  • Parse ACCESS_NUMBER:ID:NUMBER or the documented JSON equivalent and store the activation ID with your internal request reference.
  • Poll getStatus with that ID. STATUS_WAIT_CODE means the request is still waiting; STATUS_OK:CODE contains a received code.
  • Use setStatus only for a transition allowed by the reference: 1 ready, 3 request another SMS, 6 complete or 8 cancel. Do not reuse the number for another service.

Statuses, errors and uncertain requests

SMSHub-compatible actions can return text tokens, while newer routes may return JSON. Correct or rotate a BAD_KEY credential instead of retrying. BAD_SERVICE means an action or service is unsupported. NO_BALANCE requires funding; NO_NUMBERS means no matching offer is currently available; BAD_STATUS marks an invalid transition. After a timeout, reset or server error on getNumber, reconcile through the stored activation or status before purchasing again. A blind retry can create a duplicate reservation.

Fluxo de ativação de e-mail temporário

A ativação de e-mail usa rotas separadas e respostas JSON. Consulte getPriceRests, getPrices ou getRests para serviços, domínios, preços e estoque. Salve o mailId retornado por getActivation. Use getStatus para o estado e getCode para o código recebido. setStatus e requestRefund devem respeitar o estado atual e a política publicada. Uma caixa temporária não é uma caixa permanente nem um método seguro de recuperação.

Exemplos de solicitações seguras

Os valores abaixo são marcadores intencionalmente inválidos. Substitua-os apenas em um ambiente de servidor protegido. Os exemplos curl enviam parâmetros codificados separadamente sem montar manualmente uma URL.

  • Saldo: curl --get 'https://api.simub.com/stubs/handler_api.php' --data-urlencode 'api_key=YOUR_API_KEY' --data-urlencode 'action=getBalance'
  • Reservar: curl --get 'https://api.simub.com/stubs/handler_api.php' --data-urlencode 'api_key=YOUR_API_KEY' --data-urlencode 'action=getNumber' --data-urlencode 'service=tg' --data-urlencode 'country=0'
  • Ler status do SMS: curl --get 'https://api.simub.com/stubs/handler_api.php' --data-urlencode 'api_key=YOUR_API_KEY' --data-urlencode 'action=getStatus' --data-urlencode 'id=ACTIVATION_ID'
  • Ler status do e-mail: curl --get 'https://simub.com/api/mail/getStatus' --data-urlencode 'api_key=YOUR_API_KEY' --data-urlencode 'id=MAIL_ACTIVATION_ID'

Confiabilidade, segurança e uso responsável

Defina timeouts finitos, use recuo exponencial limitado ao consultar o status e pare em um estado final. Remova api_key, números, endereços e códigos dos logs. Valide respostas e limite compras simultâneas. Estoque, redes e filtros mudam; nem a disponibilidade nem a entrega do código são garantidas.

Perguntas frequentes

Onde devo guardar minha chave de API SIMUB?

Em um gerenciador de segredos no servidor ou variável de ambiente protegida. Restrinja o acesso e nunca a inclua em logs ou código cliente.

Com que frequência devo chamar getStatus?

Consulte em intervalo moderado com recuo limitado e pare ao receber uma resposta final.

Uma reserva bem-sucedida garante um código SMS?

Não. Ela apenas confirma a alocação do número; a entrega depende de redes externas e regras da plataforma.

Posso repetir getNumber após um timeout?

Primeiro verifique pelos IDs salvos, histórico ou status se uma ativação já existe, evitando cobranças duplicadas.