Minhas APIs

A visualização das APIs de sua empresa está sempre disponível a todos os usuários do projeto, porém cada usuário terá suas permissões de acordo com o perfil da conta, definido pelo administrador.



Ao acessar essa página, será exibida uma lista com as informações das APIs criadas, e ao clicar no título das colunas é possível organizar as APIs de acordo com alguns critérios, sendo eles:

  • Nome: nome definido para a API;
  • Descrição breve descrição sobre sua utilização;
  • Versão: versão em que se encontra a API em questão;
  • Documentação: link de acesso externo a documentação para que os usuários da API possam ter acesso a ela.
  • Status: a situação da API podendo estar "Ativa", "Inativa", "Bloqueada" ou "Aguardando Publicação”.

Para cada item, também é possível ver dois botões, um que permite que o usuário exclua uma API e uma segunda opção que permite que o usuário edite uma delas.


Propriedades da API

Ao selecionar um dos itens da lista, você será redirecionado para a página Propriedades da API, divididas em quatro segmentos:

  • Detalhes
  • Estrutura
  • Análise
  • Regras

Detalhes

Exibe todas as informações referente a API selecionada com suas informações divididas em boxes:


Status da API:o usuário pode alternar a configuração desse campo entre “Ativa” e “Inativa”;


Resumo da API:O campo de resumo da API, entrega as informações como:

  • URL: link de acesso a API para o consumo de suas funcionalidades externamente;
  • Responsável: identifica o criador da API;
  • Data de Criação: exibe a data em que a API foi criada;
  • Documentação: Tem a mesma função do link de acesso externo visto anteriormente na listagem de APIs.

Informações da API: Permite que o usuário edite informações gerais da API, como seu nome, versão, descrição, requisições disponíveis por mês/minuto e ativar/desativar a compressão de dados, que não altera o funcionamento da API, porém, torna o uso de dados menor.


Banco de Dados: Exibe as informações de conexão com o banco podendo estar em formato string ou no formato padrão (Host, Porta, Usuário e Senha).


Estrutura

Aqui são disponibilizadas as informações sobre a estrutura da API, sendo a página onde são realizadas alterações nas configurações dos dados da API no banco.


São 13 colunas na tabela, cada uma responsável por uma característica da API. As informações nessas colunas são:

  • Chamada do Recurso: URL base de chama dos recursos disponíveis;
  • Nome (Alias): esse campo permite que seja adicionado um "Pseudônimo" para o endpoint;
  • GET, POST, PUT/PATCH, DELETE: : Ativa/Desativa as permissões de uso de determinados métodos do recurso desejado;
  • PK: indica a presença ou não de um campo com chave primaria/primary key;.
  • Anulável: permite que um campo fique vazio ou não seja enviado em uma requisição POST;
  • Computada: indica colunas com valores gerados automaticamente pelo banco de dados;
  • Visível: habilita ou desabilita a disponibilidade de acesso do campo;
  • Coluna de Opções: Disponibiliza as opções de Exclusão de tabelas e colunas

Análise

Para qualquer negócio, o monitoramento de indicadores é essencial para se ter noção de qual caminho seguir. Com o Connect Us Cloud, coletamos informações das chamadas as suas APIs para que você possa visualizar e gerenciar seu desempenho através de uma interface de indicadores. Dados como estes ajudam a melhorar suas APIs, de forma a solucionar problemas e tomar melhores decisões de negócios relacionadas ao seu programa de API.

Aqui é possível encontrar as seguintes informações:

  • Chamadas por mês: todas as chamadas realizadas nos últimos três meses;
  • Chamadas por resultado: apresenta todas as chamadas separadas por erro ou sucesso, baseados nos códigos de status HTTP;
  • Chamadas por status: lista todas as chamadas realizadas de acordo com os códigos de status HTTP;
  • Credenciais por utilização: mostra a quantidade de credenciais de API criadas, categorizados pelo seu uso;
  • Chamadas por dia: apresenta as chamadas do mês atual ou mais recente, podendo ser filtrado;
  • Chamadas por hora: todas as chamadas do dia atual ou do mais recente que possua chamadas.
Análise de APIs

Regras

Aqui é possível manipular os dados que entram e saem da API. O sistema de regras funciona com base na linguagem JavaScript, e através dela, é possível editar dados, bloquear entradas/saídas de dados específicos ou qualquer outra validação que possa ser necessária.

Análise de APIs