API para revendedores

Revenda verificação por SMS com a API da Noir SMS: sua plataforma, seus preços, nossos números

Muita gente que precisa de um número de verificação compra pelo painel de um revendedor, por um site regional ou por um bot de chat. A API é aberta para esse tipo de negócio. Você mantém a sua marca, o seu checkout e o seu relacionamento com o cliente; a Noir SMS fornece os números e os SMS. Esta página explica como o dinheiro circula, como manter os clientes atualizados, como proteger a sua margem quando os preços mudam e, tão importante quanto, pelo que você é responsável. A referência técnica está em /pt/api/docs/.

English →

  • Mesmos preços do painel
  • Reembolso se não chegar SMS
  • Webhooks assinados

Resposta rápida

Revendedores podem usar a API da Noir SMS para oferecer números de verificação por SMS dentro da própria plataforma, painel ou bot. Você recarrega um único saldo na Noir SMS, compra números por https://noirsms.com/api/v1 com os mesmos preços de qualquer cliente e cobra dos seus clientes o que quiser; a margem é você quem define. Se você vende volume médio ou alto, pode pedir condições especiais abrindo um ticket no Suporte do painel. Webhooks sms.received assinados avisam os seus clientes em tempo real. Seus clientes precisam seguir a Política de Uso Aceitável da Noir SMS, você é responsável por abusos na sua plataforma e contas que revendem para abusadores são encerradas. Docs: https://noirsms.com/pt/api/docs/.

Highlights

01

Seus preços

Você paga o mesmo preço por número que qualquer cliente da Noir SMS e define o seu preço de venda por cima. A margem é decisão sua.

02

Um saldo só

Você recarrega um único saldo na Noir SMS. Seus clientes pagam a você pelo seu próprio checkout; eles não têm conta na Noir SMS.

03

Atualização em tempo real

Um webhook sms.received assinado avisa o seu sistema no momento em que o código chega, para você mostrar ao cliente certo.

04

Condições para volume

Vende volume médio ou alto? Abra um ticket no Suporte do painel e analisamos condições especiais para a sua conta.

Como funciona o dinheiro

Existe um único saldo: o seu. Você adiciona fundos na sua conta Noir SMS por cartão ou por USDC ou SOL, igual a qualquer outro cliente, e cada número que a sua plataforma compra pela API é debitado desse saldo. Seus clientes nunca pagam a Noir SMS. Eles pagam a você, pelo checkout, carteira ou sistema de créditos que a sua plataforma usar, e você decide quanto eles pagam.

Os reembolsos seguem a mesma lógica. Se um número não recebe SMS em 20 minutos, ele expira e o valor volta para o seu saldo na Noir SMS; se você cancelar depois de 2 minutos, também é reembolsado. Como você credita o seu cliente é decisão sua, mas o justo é espelhar: sem código, sem cobrança. Uma compra com saldo zerado falha com 402 insufficient_balance, então acompanhe GET /balance e recarregue a tempo.

Definindo preços e protegendo a sua margem

Os preços da Noir SMS seguem oferta e demanda e podem mudar durante o dia. A sua margem é a diferença entre o que você cobra e o que o número custa no momento da compra.

  • Leia os custos ao vivo em GET /services?country=xx e atualize o seu catálogo com frequência, em vez de fixar preços no código.
  • Envie max_price em todo POST /numbers. Se o custo subiu acima do que o seu preço de venda aguenta, você recebe 409 price_above_max e não é cobrado.
  • Esconda serviços e países sem estoque e trate 400 no_numbers com cuidado: o cliente não foi cobrado e pode escolher outro país.
# Seu custo por número e o estoque no Canadá, agora
curl "https://noirsms.com/api/v1/services?country=ca" \
  -H "Authorization: Bearer nsk_live_SUA_CHAVE"

# Seu saldo, para o painel parar de vender antes de acabar
curl https://noirsms.com/api/v1/balance -H "Authorization: Bearer nsk_live_SUA_CHAVE"

Volume médio e alto

Se a sua plataforma compra números todos os dias, fale com a gente. Entre na sua conta, abra o Suporte do painel e abra um ticket contando mais ou menos quantos números você compra por mês, quais serviços e países e qual é a sua plataforma. Analisamos cada pedido e podemos oferecer condições especiais para revendedores com volume médio ou alto.

As condições dependem do uso real e de um histórico limpo dentro da Política de Uso Aceitável, então ter algumas compras pela API na sua conta ajuda.

Pedir condições para volume

Mantendo seus clientes atualizados com webhooks

Configure uma URL de webhook HTTPS na página API do painel. Quando um SMS chega num número que você comprou pela API, a Noir SMS envia um POST com o evento sms.received contendo number_id, phone, service, country e o código e o texto do SMS. Guarde o id do número junto com o pedido do cliente, depois cruze cada evento e envie o código para a tela, o chat ou o e-mail dele.

Sempre valide o cabeçalho X-NoirSMS-Signature (HMAC-SHA256 sobre o timestamp e o corpo bruto, com o seu segredo de webhook) e rejeite timestamps antigos; senão, qualquer pessoa que descobrir a sua URL pode forjar códigos. Webhooks também importam para escalar: uma chave permite 120 requisições por minuto, e os webhooks não contam nesse limite.

import express from 'express';
import crypto from 'node:crypto';

const app = express();
const SECRET = process.env.NOIRSMS_WEBHOOK_SECRET; // aparece na página API do painel

app.post('/hooks/noirsms', express.raw({ type: 'application/json' }), (req, res) => {
  const { t, v1 } = Object.fromEntries(req.get('X-NoirSMS-Signature').split(',').map((p) => p.split('=')));
  const expected = crypto.createHmac('sha256', SECRET).update(t + '.' + req.body).digest('hex');
  const fresh = Math.abs(Date.now() / 1000 - Number(t)) <= 300;
  if (!fresh || expected.length !== v1.length || !crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(v1))) {
    return res.sendStatus(401);
  }
  const event = JSON.parse(req.body);
  if (event.type === 'sms.received') {
    // Encontre o pedido do SEU cliente por event.data.number_id e mostre event.data.sms.code
    notifyCustomer(event.data.number_id, event.data.sms.code);
  }
  res.sendStatus(200);
});

Suas responsabilidades como revendedor

Revender coloca você entre a Noir SMS e pessoas que nunca vemos, então as regras vão junto com os números. Seus clientes precisam seguir a mesma Política de Uso Aceitável dos clientes diretos: os números servem para verificar as próprias contas legítimas, respeitando os termos de cada plataforma. Fraude, golpes, se passar por outra pessoa, assédio, criação de contas em massa ou automatizada, burlar banimentos, spam e burlar verificações de bancos, fintechs, corretoras de cripto ou de identidade (KYC) são proibidos.

Você é responsável pelos abusos que acontecem pela sua plataforma. Na prática, isso significa publicar essas regras nos seus próprios termos, não divulgar o seu serviço para usos proibidos, não oferecer verificação de bancos, fintechs ou corretoras de cripto, limitar compras claramente automatizadas ou em massa e suspender clientes que quebrem as regras. Contas que revendem para abusadores são encerradas, e uma conta encerrada não compra números para nenhum dos seus clientes.

O que dizer aos seus clientes

Os números só recebem SMS, sem chamadas nem envio de mensagens. Cada número serve para uma verificação em um serviço e depois é reciclado pela operadora, então não é um número de recuperação de longo prazo; quem for manter a conta deve adicionar depois o próprio telefone, e-mail ou app autenticador. Os números são de operadoras móveis, não VoIP, então costumam funcionar onde números VoIP são recusados, mas nenhum app aceita todos os números, e é exatamente por isso que existe o reembolso automático.

Passo a passo

  1. Abasteça um saldoCrie uma conta na Noir SMS, adicione saldo e gere a sua chave de API na página API do painel.
  2. Monte o seu catálogoLeia serviços, países e custos ao vivo pela API, defina os seus preços de venda e envie max_price em toda compra.
  3. Entregue e fiscalizeEnvie os códigos aos clientes pelo webhook sms.received e faça valer a Política de Uso Aceitável na sua plataforma.

Perguntas frequentes

Revendedores têm desconto ou preço por volume?

Por padrão, revendedores pagam o mesmo preço por número que qualquer cliente da Noir SMS, sem taxa de API. Se você vende volume médio ou alto, abra um ticket no Suporte do painel e analisamos condições especiais para a sua conta.

Meus clientes precisam de conta na Noir SMS?

Não. Eles compram de você e pagam a você. Só a sua conta tem saldo e chave de API na Noir SMS.

O que acontece com o meu cliente se o SMS não chegar?

O número expira depois de 20 minutos e o valor volta automaticamente para o seu saldo na Noir SMS. Recomendamos reembolsar o seu cliente da mesma forma.

Posso ter mais de uma chave de API?

Cada conta tem uma chave, e gerar outra substitui a antiga. Use webhooks em vez de muito polling para ficar dentro de 120 requisições por minuto.

Sou responsável pelo que os meus clientes fazem?

Sim. Seus clientes precisam seguir a mesma Política de Uso Aceitável, você é responsável por abusos na sua plataforma e contas que revendem para abusadores são encerradas.

Mais páginas da API

Comece a construir com a API da Noir SMS

Crie uma conta grátis, adicione saldo e gere a sua chave de API na página API do painel.