Skip to main content

Planos de consumo

Visão Geral​

Ao expor uma API para consumo, uma preocupação comum é sobre como protegê-la de abusos no consumo que coloquem em risco a sua disponibilidade geral. Uma das opções utilizadas é a configuração de limites de requisições que a API pode atender em um dado intervalo de tempo, conhecido como rate limiting.

A definição desses limites pode ser feita na API propriamente dita, bem como em um nível mais granular limitando por consumidor. Em um contexto mais amplo, essa limitação por consumidor pode evoluir para estratégias de monetização, com a definição de faixas de valores e limites de consumo para diferentes públicos ou aplicações.

No DHuO, um plano de consumo é essa entidade que possibilita limitar a quantidade de requisições às APIs por parte dos consumidores. Tanto consumidores criados pela interface de gerenciamento (Manager) quanto consumidores criados por usuários do Dev Portal podem ser associados a um plano de consumo. Os planos são associados a cada consumidor pelo gerenciamento de consumidores da organização. Para saber mais, acesse a seção Consumidores de API da Administração do API Manager.

Informação adicional

A limitação de consumo nas APIs também pode ser configurada, independente da configuração de planos. As duas configurações não são excludentes. Para saber mais sobre como configurar os limites na API, acesse a seção Rate Limiting da lista de plugins do API Gateway DHuO e Kong.

Atenção!

Para o API Gateway conseguir limitar as requisições a uma API de acordo com plano, é necessário:

  • A existência de um mecanismo de autenticação configurado na API
  • A existência de uma credencial de acesso à API válida, vinculada ao consumidor associado ao plano

Configuração​

Planos de consumo são gerenciados no contexto da Organização. A partir da home, acesse o ícone de configurações da Organização ⚙ menu > Planos. Na página de planos, eles podem ser cadastrados, editados e excluídos.

Permissões​

Apenas usuários com papel de administrador da organização (Org Admin) podem gerenciar planos. Para saber mais, acesse a seção Papéis e permissões.

Parâmetros​

Aqui estão os parâmetros para configuração de um plano:

  • Nome: Obrigatório. Nome do plano.
Informação adicional

Os planos são únicos por Organização. Não é possível ter mais de um plano com o mesmo nome.

  • Descrição: Texto opcional para detalhes sobre o plano.
  • Status: Obrigatório. Determina se o plano estará disponível para atribuir aos consumidores de API. Apenas planos ativos podem ser atribuídos aos consumidores.
  • Quantidade de requisições: Obrigatório. Define a quantidade máxima de requisições que um consumidor associado a esse plano poderá realizar.
  • Unidade de tempo: Obrigatório. Define a unidade de tempo que será aplicado o limite de requisições configurado. Opções: segundo, minuto, hora, dia, mês.
Atenção!

Não é possível inativar ou excluir um plano caso ele esteja associado a algum consumidor de API.

É necessário removê-lo de todos os consumidores relacionadas para efetuar a exclusão ou inativação do plano. Para saber mais sobre a edição de planos dos consumidores, acesse a seção Consumidores de API da Administração do API Manager.