No painel, não na API
O que a API cobre e o que deve ser consultado no painel da plataforma.
A API pública é focada no fluxo de emissão de eSIM: catálogo, clientes, pedidos e acompanhamento. Algumas áreas ficam fora da API, de propósito, e devem ser usadas pelo painel da plataforma.
O que a API cobre
| Área | Endpoints |
|---|---|
| Contexto da chave | GET /v1/whoami |
| Catálogo de planos | GET /v1/agencies/{agencyId}/plans |
| Clientes | Cadastro e busca |
| Pedidos | Criar, listar, detalhar, reenviar link, cancelar |
O que fica no painel
Estas áreas não têm endpoints na API pública e devem ser acessadas pelo painel administrativo da plataforma.
Relatórios financeiros e faturamento
O acompanhamento financeiro — receitas, faturas e o consolidado de vendas — é
feito no dashboard, não pela API. A API expõe o preço de venda de cada
pedido (price), mas não substitui os relatórios de faturamento:
- Agências diretas recebem fatura mensal individual.
- Operadores recebem uma fatura consolidada de toda a rede; as agências da rede não recebem fatura da plataforma.
Gestão de usuários
A criação e a administração de usuários (por exemplo, Admin da agência e Usuário de Caixa), assim como a geração e revogação de chaves de API, são feitas no painel.
A chave de API atua em nome da(s) agência(s) a que tem acesso, mas não gerencia usuários nem contas — isso é responsabilidade do painel.
Em resumo
Use a API para integrar a emissão de eSIM ao seu sistema; use o painel para finanças, faturamento e gestão de usuários/chaves.