Planos de uso

Planos de uso controlam como consumidores utilizam suas APIs no TunnelHub.

Para que servem

Eles permitem associar regras de consumo a:

• chaves de API;

• clientes ou parceiros específicos;

• conjuntos de APIs ou estágios publicados.

No produto atual, o vínculo com a API costuma ser feito por estágio publicado, o que ajuda a separar consumo por versão ou contexto operacional.

Casos de uso comuns

• separar consumidores internos e externos;

• aplicar políticas por parceiro;

• organizar acesso por produto ou contrato;

• controlar a evolução do consumo ao longo do tempo.

Relação com chaves de API

Chaves de API normalmente são associadas a planos de uso. O plano define o contexto de consumo; a chave identifica o consumidor naquele contexto.

Na prática:

• o plano de uso representa a política;

• a chave de API representa o consumidor;

• a combinação dos dois permite governar acesso e operação.

Quando criar planos diferentes

Considere separar planos de uso quando houver diferença de:

• tipo de consumidor;

• criticidade do serviço;

• expectativa de volume;

• contrato comercial ou SLA;

• escopo de APIs liberadas.

O que revisar antes de publicar

Antes de ativar um plano de uso, confirme:

• quais APIs ou estágios ele cobre;

• quais consumidores estarão vinculados a ele;

• se o plano faz sentido para o contexto de negócio;

• se a API também precisa de autenticação adicional por OAuth.

Quando o cenário exigir, revise também limites de throughput, quota e combinação com segurança por escopos.

Boas práticas

• crie nomes orientados a negócio;

• mantenha uma descrição clara de quem deve usar cada plano;

• evite compartilhar a mesma key entre consumidores diferentes;

• combine planos de uso com autenticação forte quando a API exigir maior segurança;

• revise periodicamente planos antigos ou pouco utilizados.