Como cadastrar uma API?

API

A definição de quais APIs serão expostas e quais recursos existirão em cada API é o ponto de partida para a configuiração do sistema.

Uma API é definida por um conjunto de recursos. Estas APIs serão utilizadas em diversas outras áreas, como no estabelecimento de políticas de acesso e na apresentação dos relatórios e gráficos. Portanto, é necessário cadastrar estes dados antes de iniciar o manejo de outras funcionalidades dentro do Manager.

Criando uma API

Para adicionar uma nova API, deve-se clicar em Create API, botão no canto inferior direito (+).

Três opções serão exibidas, sendo elas:

  • (+) Create API: Permite criar uma API inserindo todos os dados manualmente;
  • ({...}) Create new API from swagger file: Permite criar uma API importando um arquivo Swagger,JSON ou YAML.
  • (*) Create API GraphQL: Permite criar uma API GraphQL inserindo os dados obrigatórios manualmente. 

Após a escolha de uma das opções citadas acima, a tela de cadastro será exibida e os campos obrigatórios devem ser preenchidos.

A opção Deployable Environments, caso já possua algum ambiente cadastrado em Environments, será exibida. Caso contrário, poderá ser adicionado posteriormente, não sendo obrigatório sua marcação nesse momento inicial.

A opção de Access token expires in determina o período de tempo de expiração do token para uma determinada API. Caso esse valor esteja vazio, será assumido o valor padrão configurado via System config.

A opção API Visibility está relacionada a visibilidade da sua API. Após escolher uma das opções, a API criada será exibida apenas para os usuários autorizados, podendo ser dos seguintes tipos:

  • Organization: a API estará visível para todos os usuários logados no sistema;
  • Teams: A API será visível também para os usuário contidos nos times selecionados nessa opção. Para saber mais sobre a criação de Teams, veja aqui;
  • Only me: a API será visível apenas para o usuário que a criou;
  • Add users: a API será visível também para os usuários adicionados, conforme mostra a imagem abaixo:

Todos os usuários existentes no API Manager serão exibidos mostrada acima.

Para alterar a permissão de um usuário específico, basta selecionar o usuário e escolher entre as opções: Can view ou Can edit.

A opção Can edit concede ao usuário selecionado a permissão para editar as informações da API. Porém, essa permissão de edição não ultrapassará as regras de acesso que foram definidas na Role deste usuário, não sendo possível realizar qualquer outra ação na API como CloneExport e etc.

OBS: Para configurar corretamente as opções de Visibilidade de sua API, será necessário que os usuários e times já estejam cadastrados.

A opção de Private API, quando marcada, não permite que a API esteja disponível para consumo no Developer Portal.

Ao clicar em SAVE and NEXT, os dados básicos da API serão salvos. Os dois próximos passos não são obrigatórios, porém, se a importação de um Swagger tive sido efetuada anteriormente, os dados dos recursos já estarão preenchidos.

A última etapa na criação da API é a tela de Publish:

Esta tela será apresentada durante a criação de uma API. Nela é possível realizar o deploy da API, caso a opção Environments tenha sido selecionada no início do cadastro. É possível também criar templates de teste, onde será gerado um plano e uma APP para serem vinculados a API cadastrada. Essa opção possibilitará o uso imediato da sua API.

As APIs cadastradas estão dispostas em cards. Em cada card, informações importantes sobre a API estarão disponíveis, conforme imagem abaixo:

  • Name: Exibe o nome dado a API. Ex: Swagger Petstore;
  • Version: Indica qual é a versão da API cadastrada. Ex: 1.0.0;
  • Description: Contém uma breve descrição sobre a API cadastrada;
  • Plans: Exibe os planos pertencentes a API;
  • Editor de Swagger: Esse botão permite ao usuário editar a estrutura da API. 
  • Download Swagger: Nesse botão, é possível realizar o download do arquivo Swagger, em formato JSON, da API cadastrada;
  • Trace: Redireciona para página de trace da API;
  • Create Version: Esse botão é utilizado para gerar uma nova versão da API. Ao clicar, abrirá uma nova tela contendo todos os dados da API já preenchidos para facilitar a criação da nova versão. Esses dados podem ser alterados pelo usuário e seguirão o fluxo normal de criação de uma nova API;
  • Clone API: Esse botão é utilizado para criar uma nova API a partir da API atual. No caso de clonar a API, é necessário alterar apenas seu nome e versão. Todos os dados referentes a Resource e Interceptors serão mantidos na API clonada, conforme a API original;

 

Para maiores dúvidas e/ou sugestões entre em contato com o nosso suporte através do zendesk, nossa equipe estará sempre a disposição para te ajudar! :)

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

Comentários

Powered by Zendesk