eSIM de Viagem — API
Conceitos

Catálogo e precificação

Por que um plano só aparece na API depois de ser precificado no painel.

O endpoint GET /v1/agencies/{agencyId}/plans devolve o catálogo vendável da agência — e "vendável" tem um requisito importante: o plano precisa ter um preço de venda configurado.

Planos sem preço de venda definido não são retornados pela API. Se a listagem vier vazia ou menor que o esperado, quase sempre é porque os planos ainda não foram precificados.

A precificação é feita no painel

Quem define o preço de venda de cada plano é o administrador da conta, pelo painel da plataforma — não pela API. A API é somente leitura no catálogo: ela expõe o preço já configurado (price), mas não cria nem altera preços.

Isso é intencional: a precificação é uma decisão comercial da agência/operador, controlada no painel, e a API apenas reflete o resultado.

O que a API retorna

Cada item do catálogo traz o preço de venda da agência no campo price (em BRL). Preços internos (custo, preço do operador) nunca são expostos.

{
  "id": "9b2e6c1a-...",
  "name": "Europa 10GB",
  "coverages": ["FR", "DE", "IT"],
  "dataGb": "10.00",
  "validityDays": 30,
  "price": "149.90",
  "currency": "BRL"
}

O total da resposta reflete apenas os planos precificados — então a paginação nunca aponta para planos que não seriam retornados.

Antes de integrar

Precifique os planos no painel

Peça ao administrador da conta que configure o preço de venda dos planos que a agência vai comercializar.

Confirme pela API

Liste os planos com GET /v1/agencies/{agencyId}/plans e verifique se os planos esperados aparecem. Os que faltarem provavelmente estão sem preço.

On this page