Glossário
Os termos que aparecem na documentação e nos payloads da V2, reunidos em um só lugar.
Papéis
| Termo | Significado |
|---|---|
| Agência / Dealer | Sua conta revendedora. Opera com carteira pré-paga. |
| 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 de uma operadora. Identificado por product_id. |
| Variação | Plano específico (dias/GB/região). Seu id é o `variation_id` enviado na ativação. |
Ativação
| Termo | Significado |
|---|---|
| Ativação / Pedido | A ordem que provisiona uma linha. Identificada por id. |
| eSIM | Chip virtual (activation_type: "esim"). |
| Chip físico | Chip físico (activation_type: "chip"). O endereço de entrega é informado pelo painel. |
| `external_id` | Identificador seu, opcional, para referenciar a ativação nas consultas. |
| `activation_date` | Data de início do plano. |
| `status` | Código 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. |
| EID | Identificador do eSIM. |
| IMEI | Identificador do aparelho onde o chip será usado. |
| QR Code | Imagem que ativa o eSIM (qrcode_url). |
| 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). |
| 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 |
|---|---|
| `device_name` | Rótulo do app/dispositivo que identifica o token no login. |
| Token | Credencial Bearer devolvida no login, enviada no header Authorization. |
Próximos passos
- Comece pelo Quick Start.
- Veja como os termos se conectam no Ciclo de uma ativação.