Glossário
Os termos que aparecem ao longo da documentação e nos payloads da API, reunidos em um só lugar.
Papéis
| Termo | Significado |
|---|---|
| Agência / Dealer | Sua conta revendedora. Opera com carteira pré-paga e vende ativações. |
| Vendedor / Seller | Usuário vinculado à agência que realiza vendas e recebe comissão. |
Catálogo
| Termo | Significado |
|---|---|
| Operadora | A Operadora representa a entidade que fornece a conectividade ou serviços de rede que alimentam os Produtos da plataforma. |
| Produto | Oferta comercial que agrupa uma operadora e suas variações. Identificado por idProduct. |
| Variação | Plano específico dentro do produto (dias/GB/região). É o id da variação que você envia em items[].sequence_item — vem como options_sequence (ou sequence) no catálogo. |
| Item | Cada linha de um pedido, referente a uma variação escolhida. |
Ativação
| Termo | Significado |
|---|---|
| Ativação / Pedido | A ordem que provisiona uma linha. Identificada por idOrder. |
| eSIM | Chip virtual (type: "esim"). |
| Chip físico | Chip físico (type: "chip").O endereço de entrega é informado pelo painel. |
| `external_id` | Identificador seu, opcional, para referenciar a ativação nas consultas. |
| `dateActive` | Data de início do plano. Não pode ser no passado. |
| `order_status` | Código numérico do estágio: 2 Aberto, 6 Processando, 3 Concluído, 7 Fechado, 10 Parcial, 9 Faltando ICC, 8 Cancelado. |
Dados técnicos do chip
| Termo | Significado |
|---|---|
| ICC / ICCID | Número impresso no chip físico que o identifica na rede. |
| EID | Identificador do eSIM. |
| IMEI | Identificador do aparelho onde o chip será usado. |
| PIN | Código de segurança do chip, quando a operadora exige. |
| QR Code | Imagem que ativa o eSIM (pathQRCode). |
| LPA | String de provisionamento contida no QR Code (qr_content), no formato LPA:1$.... |
Financeiro
| Termo | Significado |
|---|---|
| Carteira / Saldo | Créditos da agência (current_balance). Cada ativação debita; recargas creditam. |
| Charge | Cobrança para recarregar a carteira, via Stripe ou Ebanx. |
| Estorno | Devolução do valor à carteira quando uma ativação é cancelada. |
| Frete | Valor de envio do chip físico por estado (sedex / pac). |
Acesso
| Termo | Significado |
|---|---|
| `app_name` | Nome do app criado no portal WEB para liberar o Webservice. |
| Token | Credencial Bearer devolvida no login, enviada no header Authorization. |
Próximos passos
- Comece pelo Quick Start.
- Veja como esses termos se conectam no Ciclo de uma ativação.