Visão Geral

Sobre a API

O Webservice V1 permite que a sua agência revenda ativações de eSIM e chip físico de forma programática: consultar catálogo e preços, criar e acompanhar ativações, gerenciar a carteira de créditos e ver os indicadores do seu painel.

Conceitos-chave

• Agência (dealer) — sua conta revendedora, que opera com uma carteira pré-paga.
• Catálogo — operadoras, produtos e variações (planos) disponíveis para você, com preço por agência.
• Ativação — o pedido que provisiona uma linha (eSIM ou chip físico) para o cliente final.
• Carteira — cada ativação debita o saldo; recargas via Stripe ou Ebanx creditam.

Todos os termos estão reunidos no Glossário.

Por onde começar

1. Ative o Webservice na sua conta e gere o token — veja o Quick Start.
2. Autentique cada chamada com o token Bearer — veja Autenticação.
3. Descubra o que vender no catálogo — veja Produtos e operadoras.
4. Crie sua primeira ativação — veja Ciclo de uma ativação.