Ciclo de uma ativação

Uma ativação nasce como um pedido, é provisionada na operadora e termina concluída ou cancelada. Este guia mostra o fluxo ponta a ponta: criar → acompanhar → cancelar.

Antes de começar

Você vai precisar do idProduct e do sequence do item — veja Produtos e operadoras — e de saldo na carteira, já que criar a ativação debita o valor automaticamente (veja Créditos e saldo).

1. Crie a ativação

Envie um POST /activations. O corpo combina o item escolhido, os dados do chip e os dados do cliente.

bash

curl --request POST \
  --url 'https://portal.woo-fi.com/api/webservice/v1/activations' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {seu-token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "esim",
    "dateActive": "2026-05-10",
    "idProduct": 90,
    "chips": [
      { "eid": "89852342022137421003", "imei": "351756051523999" }
    ],
    "items": [
      { "sequence_item": 411 }
    ],
    "name": "João Silva",
    "email": "joao.silva@example.com",
    "phone": "(11) 98765-4321",
    "document": "182.177.290-34"
  }'

Campo	Tipo	Obrigatório	Descrição
`type`	String	Sim	`esim` ou `chip` (chip físico).
`dateActive`	String	Sim	Data de início do plano (`AAAA-MM-DD`). Não pode ser no passado.
`idProduct`	Number	Sim	Produto escolhido no catálogo.
`items`	Array	Sim	Itens do pedido; cada `sequence_item` é o id da variação do item (campo `options_sequence` no catálogo).
`chips`	Array	Sim	Lista de chips a ativar (mínimo 1). Os campos técnicos de cada chip são opcionais — envie os que fizerem sentido para a ativação.
`name`, `email`	String	Sim	Nome e e-mail do cliente final.
`phone`, `document`	String	—	Telefone e documento do cliente (opcionais).

Cada item de chips aceita os seguintes campos técnicos, todos opcionais:

Campo	Para que serve
`eid`	Identificador do eSIM.
`icc`	Número impresso no chip físico (ICCID).
`imei`, `imei2`	IMEIs do aparelho onde o chip será usado.
`pin`, `line`	Dados adicionais do chip, quando aplicável.

A resposta traz o pedido criado, com idOrder e os chips já com o QR Code:

json

{
  "message": "Pedido realizado com sucesso!",
  "order": {
    "idOrder": 26660,
    "type": "esim",
    "idProduct": 90,
    "quantity": 1,
    "chips": [
      {
        "sequence": 27208,
        "EID": "89852342022137421003",
        "IMEI": "351756051523999",
        "pathQRCode": "https://portal.woo-fi.com/qr_codes/example.png"
      }
    ]
  }
}

eSIM e chip físico se comportam diferente

No eSIM, quando o QR Code está disponível ele vem em pathQRCode (imagem) e o conteúdo LPA em qr_content ao consultar a ativação; caso contrário, é provisionado durante o processamento. No chip físico, não há QR Code — o ICC vem impresso no chip.

2. Acompanhe a ativação

Consulte o estado atual com GET /activations/{id}. O {id} aceita o ID da ativação ou o external_id.

bash

curl --request GET \
  --url 'https://portal.woo-fi.com/api/webservice/v1/activations/26660' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {seu-token}'

A resposta traz os dados do pedido, o order_status (código numérico do estágio), o order_qrcode e os chips.

O campo order_status assume estes valores:

`order_status`	Rótulo	Significado
`2`	Aberto	Pedido criado, aguardando ativação.
`6`	Processando	Ativação em andamento na operadora.
`3`	Concluído	Linha ativada com sucesso.
`7`	Fechado	Pedido encerrado.
`10`	Parcial	Parte dos itens foi ativada (pedidos com múltiplos itens).
`9`	Faltando ICC	Falta o `icc`/`eid` do chip para provisionar.
`8`	Cancelado	Pedido cancelado (com estorno).

A data de início vale

A linha é provisionada para começar na data informada em dateActive. Depois de Concluído ou Cancelado, o pedido é imutável — não é possível editar chip nem status.

3. Liste suas ativações

GET /activations?page=1 retorna as ativações da sua agência, paginadas. Veja Paginação para percorrer as páginas.

4. Cancele uma ativação

Se precisar desfazer, use POST /activations/cancel/{id}. O cancelamento devolve o valor à carteira (estorno).

bash

curl --request POST \
  --url 'https://portal.woo-fi.com/api/webservice/v1/activations/cancel/26660' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {seu-token}'

json

{ "message": "Ativação cancelada com sucesso." }

Nem todo pedido pode ser cancelado

Só é possível cancelar enquanto o pedido não estiver Concluído nem Fechado. Um pedido já cancelado ou já concluído retorna 400.

Próximos passos

Garanta saldo antes de ativar em Créditos e saldo.
Teste o fluxo na referência: Create Activation, Get one activation e Cancel Activation.