Skip to main content
Recursos acumulam eventos ao longo do ciclo. Licenças fazem o oposto: sua aplicação informa quantos existem agora, e a Aira cobra a última quantidade conhecida de cada cliente do escopo do contrato a cada ciclo.
Aira — Catálogo de licenças

​
O que é uma licença

Licenças representam quantidades que podem variar ao longo do mês, como usuários ativos, filiais ou dispositivos. Em vez de somar acontecimentos, cada leitura declara um estado: “neste momento existem 42”. São duas coisas com nomes parecidos:
  1. A licença — o que você vende por unidade, cadastrado uma vez no catálogo: um nome, o item de catálogo que vai para a fatura e um Código único.
  2. A leitura — a fotografia de quantas unidades existiam em um momento, sempre identificada pela licença, pelo cliente e pelo momento a que se refere. Junto vem a lista do que foi contado, um item para cada usuário, filial ou dispositivo. É o que a Aira também chama de saldo: os dois termos designam a mesma coisa nesta documentação.
A quantidade de licenças em cada dia é definida pela última leitura enviada para o cliente até o fim daquele dia. Se nenhuma leitura for enviada, a última quantidade conhecida é mantida, e é ela que entra no cálculo do ciclo, por quantos ciclos forem necessários.
Uma licença é o contrário de um contador: ela não cresce sozinha. Cada leitura substitui a anterior como quantidade vigente, para cima ou para baixo.
Quem informa as leituras é a sua aplicação, não a Aira. A área Licenças só exibe o que já foi reportado. Veja Reportar saldos para o passo a passo da integração.

​
Como licenças se encaixam no fluxo

1

Licença (catálogo)

Você cadastra a licença com um nome, um item de catálogo e um código.
2

Saldos (leituras)

Sua aplicação reporta periodicamente quantas unidades cada cliente tem, identificando a licença pelo código.
3

Plano (precificação)

Uma cobrança do tipo Cobrança por licença no plano aplica o preço sobre a quantidade reportada.
4

Fatura

O resultado é um item de linha na fatura, com a quantidade cobrada e o detalhamento do preço.

​
Licença ou recurso


​
Criar uma licença

Aira — Modal de criação de licença, com Nome, Tipo de item e Código
  1. Acesse Licenças no menu lateral
  2. Clique em Adicionar licença
  3. Preencha:
    • Nome — o nome exibido no catálogo e sugerido para a cobrança no plano (ex: “Usuários”)
    • Tipo de item — o item de catálogo que a cobrança usa na fatura; é possível criar um item novo ali mesmo
    • Código — o identificador que a sua aplicação usa para dizer de qual licença está falando (ex: users)
  4. Clique em Adicionar licença
Restrições do Código:
  • Único por workspace
  • Definido na criação; depois disso o campo fica bloqueado na edição
  • Aceita apenas letras, números, hífens (-) e underscores (_)

​
Acompanhar os saldos

Abrir uma licença mostra a Quantidade atual de cada cliente e a Última atualização de cada um.
Aira — Saldo atual de cada cliente em uma licença
Corrigir uma quantidade é seguro: informar de novo o mesmo momento com o número certo não apaga nada, e sim acrescenta uma versão nova daquele momento. O dia corrigido passa a aparecer marcado como Corrigido no histórico.

​
Arquivar licenças

No menu de cada licença, Arquivar tira a licença da listagem do catálogo e do seletor de licenças na edição de planos, e bloqueia a edição dos seus dados. Licenças arquivadas exibem o selo Arquivada e podem ser reexibidas pelo filtro Exibir licenças arquivadas; Desarquivar reverte a ação.
Arquivar é uma organização de catálogo, não uma interrupção de cobrança. Leituras continuam sendo aceitas para o código, e cobranças de licença já configuradas em planos continuam sendo faturadas normalmente. O código também continua reservado, e uma nova licença não pode reutilizá-lo.

​
Próximos passos

  • Reportar saldos — envie as leituras de quantidade pela API
  • Recursos — para cobranças baseadas em eventos acumulados
  • Planos — monte o plano que vai precificar a licença