Plans

Um plano define um conjunto de interceptores que serão executados dentro do API Gateway. Uma API pode conter vários planos e cada plano só é executado quando vinculado a uma app ou um access token.

Ao agrupar interceptores em um plano, você consegue delimitar faixas diferentes de uso para as suas APIs, estabelecendo políticas de fluxo distintas para cada faixa. Isso te dá maior controle a respeito de como cada tipo de usuário consumirá suas APIs.

Uma API pode ter diversos planos, representando os diferentes controles de fluxo para a API, mas cada plano só pode ser vinculado a uma única API.

Lembre-se também que é necessário vincular um plano a uma app ou access token.

Esse funcionamento está representado na imagem abaixo:

Funcionamento

A imagem a seguir representa o funcionamento de um plano dentro do Gateway.

A partir da recepção de uma requisição, o funcionamento ocorre desta forma:

Assim que a rota é identificada (conforme as informações cadastradas da API), os interceptores configurados na API são executados;
Na execução dos interceptores, o Gateway identifica os apps e/ou access tokens vinculados;
São executados os interceptores dos planos associados às apps e/ou access tokens identificados.

Listagem de planos

Você pode acessar todos os planos existentes clicando em Plans, no menu principal do Manager. Nessa mesma página você pode criar novos planos ou editar os existentes (leia sobre isso nas próximas páginas).

A página inclui a listagem de planos e um campo de busca de planos por API ou por palavras-chave.

A listagem apresenta o nome e descrição de cada plano, bem como a API associada a ele. Caso o plano seja o padrão da API, é exibida a etiqueta Default Plan ao lado do nome para identificação.

Cada API pode ter vários planos associados, mas apenas um é cadastrado como o Plano Padrão (Default Plan).

Thanks for your feedback!

EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]