Definindo Planos de Uso para Gerenciar o Acesso do Assinante às APIs

Descubra como definir planos de uso para gerenciar o acesso do assinante a APIs com o API Gateway.

Depois de criar um gateway de API e implantar uma ou mais APIs nele, os gerentes de plano de API geralmente querem:

• monitorar e gerenciar consumidores de API e clientes de API que acessam APIs
• configurar diferentes camadas de acesso para diferentes clientes.

Como gerente de planos de API, você pode monitorar e gerenciar o acesso à API criando planos de uso e assinantes. Consulte Planos de Uso e Direitos, Assinantes e Tokens do Cliente.

Você pode tornar o acesso à API sujeito a limites de taxa e cotas adaptados às necessidades específicas do cliente, permitindo configurar diferentes camadas de acesso para diferentes clientes. Por exemplo, talvez você queira oferecer três camadas de acesso às suas APIs: uma camada Gold, permitindo até 1000 solicitações por hora; uma camada Silver, permitindo até 500 solicitações por hora; e uma camada Bronze, permitindo até 100 solicitações por hora. Você também pode impor um limite de taxa geral de 10 solicitações por segundo para cada cliente, para garantir que o uso pesado por um cliente não afete outros clientes.

Para configurar um plano de uso e um assinante para gerenciar o acesso a uma API, você precisa:

• Tornar uma implantação de API elegível para inclusão em um plano de uso.

  Para tornar uma implantação de API elegível para inclusão em um plano de uso, especifique o local de um token de cliente passado em uma solicitação. Depois que a implantação de API tiver sido incluída em um plano de uso, as solicitações de clientes de API inscritos deverão incluir o token de cliente nesse local para acessar a implantação de API. Você especifica o local do token do cliente em uma política de solicitação de plano de uso global para todas as rotas em uma especificação de implantação de API. Consulte Tornando uma Implantação de API Elegível para Inclusão em um Plano de Uso.

• Crie um plano de uso com um direito que especifique a implantação de API como destino.

  Depois de tornar a implantação de API elegível para inclusão, você pode criar uma definição de plano de uso que inclua um direito que especifique a implantação de API como destino e, opcionalmente, especifique um limite de taxa e uma cota. Se o número de solicitações em um determinado período exceder uma cota de solicitação, você poderá especificar se as solicitações continuarão a ser permitidas ou serão rejeitadas. Se uma solicitação for rejeitada porque a cota foi excedida, o cabeçalho de resposta indicará quando a solicitação poderá ser repetida. Consulte Criando um Plano de Uso.

• Crie uma definição de assinante que especifique o plano de uso.

  Depois de criar um plano de uso, você pode criar uma ou mais definições de assinante para seus clientes (consumidores de API) e seus clientes de API. Uma definição de assinante inclui nomes de cliente e tokens de cliente para identificar exclusivamente clientes de API e especifica o plano de uso que lhes dá acesso às suas APIs. Consulte Criando um Assinante.

Depois de configurar um plano de uso, você pode usar métricas para entender padrões de uso e enviar mensagens de alarme quando os limites de tarifa e as cotas forem abordados e excedidos. Consulte Métricas do Serviço API Gateway.