Overview de APIS

A tela de overview contém todas as informações da API. Por ela, é possível editar os dados cadastrados da API, criar nova versão, clonar API, deletar e obter informações de tráfego.

Por meio desta tela, serão realizadas as alterações cadastrais da API. Cada fluxo será alterado de forma independente, sendo necessário clicar na opção de edição de cada parte, sendo elas: API Basic Definitions, Resources and Operations e Flows.

A cada alteração feita será disponibilizado duas opções de salvar:

  • SAVE: essa opção salvará as alterações feitas na mesma Revisão do cadastro;
  • SAVE AS NEW REVISION: essa opção salvará as alterações feitas, porém será criado automaticamente uma nova Revisão da API cadastrada. Os dados básicos são replicados para todas as Revisões, mas os Recursos e Flows são salvos conforme alterações realizadas em cada Revisão.

OBS: A Revision é semelhante à revisão de um documento. É indicado para mudanças pontuais realizadas no durante o cadastro de uma API. Para modificações maiores, é recomendável a criação de uma nova versão.

API Basic Definitions

Em API Basic Definitions, é possível visualizar as informações gerais da API.

Através de uma determinada revisão, será possivel visualizar seu arquivo Swagger pelo Swagger Editor, basta selecionar a Revisão desejada e clicar no ícone Swagger, posicionado logo após o campo Revision.

Dentro desta tela também existe a seção Portal Settings, usado para configurar a visibilidade e disponibilidade da sua API dentro do Portal de Desenvolvedores. As opções disponíveis são:

  • API available on Register New App: indica se a API em questão terá sua visualização na seção Register New App do Portal. Caso este opção seja desligada, sua API não será acessível para consumo de APPs.
  • API ready for tryout on API Browser: designa se a API estará disponível para teste via Portal de Desenvolvedores. Caso marcado, será necessário selecionar os ambientes em que sua API estará disponível (por meio do botão ADD TRYOUT ENVIRONMENTS) para a execução dos testes, juntamente com a seleção de qual Revisão será aplicada.

OBS: Se o usuário selecionar a opção LAST REVISION no campo Revision durante a configuração dos ambientes, será utilizado para Tryout sempre a última revisão da API criada, mesmo que uma Revisão tenha sido cadastrada após a configuração.

Resources and Operations

Em Resources and Operations, pode-se visualizar todos os recursos e operações inseridos no cadastro de API.

Na edição, o usuário será redirecionado para a tela de atualização de Resources.

Flows

Em Flows, pode-se visualizar todos os interceptos inseridos em todos os pontos dos recursos e operações cadastrados na API.

Na edição, o usuário será redirecionado para a tela de atualização de Flows.

Environments Stats

Essa opção traz ao usuário informações de tráfego e dados vinculados a API.

  1. É possível filtrar os dados por Environments associados à API, estando estes acessíveis no Gateway ou não;
  2. Informa o número de Apps vinculados à API;
  3. Informa o número de Calls realizadas à API nos últimos 30 dias;
  4. Acesso a tela de Trace da API;
  5. Acesso a tela de Analitycs.

Plans

Em Plans, serão listados todos os planos pertecentes à API. É possível alterar os dados cadastrais do plano clicando em seu nome, e o usuário será direcionado para a tela de cadastro. O plano, em cor azul, é o plano cadastrado como padrão da API, os demais, em cinza, são os planos não padrão.

API Actions

Possibilita ao usuário realizar ações na API. Dentre elas:

  • Clone: ao clonar uma API, uma cópia idêntica é gerada. Todos os recursos, interceptors e dados cadastrais são duplicados, sendo necessário apenas alterar o nome e base path da nova API;
  • Export: ao realizar a exportação da API, será feito o download da API com todos os dados cadastrados. Essa opção é utilizada quando é necessário realizar o upload da mesma API em diferentes ambientes;
  • New version: ao criar uma nova versão da API, seus dados básicos serão carregados na tela, porém o nome ou a versão deverão ser alterados. Os dados contidos no Flow não serão replicados.
  • Delete: está opção removerá a API cadastrada.

Tem mais dúvidas? Envie uma solicitação

Comentários

Powered by Zendesk