O painel de consumo de APIs é a tela para análise sintética de requisições feitas por APIs na sua base de dados.

    Nota!

• API - Interface de Programação de Aplicações, conjunto de endpoints de que formam um recurso como por exemplo: Títulos a Receber.
• Requisições – Cada chamada em um endpoint de API.
• Endpoint – URL específica de uma API para acessar alguns recursos, sendo GET (Consulta), POST (Inclusão), PUT ou PATCH (Alterações) e DELETE (Exclusões).

Veja como o Painel está estruturado:

1. Filtro de Perfis de Acesso (Usuário) – Corresponde aos perfis de acessos dos usuários criados no sistema para acessar às APIs. Um cliente pode ter múltiplos usuários, tendo apenas um pacote de API contratado, para, por exemplo, controlar os acessos aos dados por diferentes players (empresas de Softwares que se integram por APIs no Sienge). É possível selecionar neste campo um perfil específico para ser analisado ou selecionar a opção “Todos” para realizar uma análise do pacote geral de APIs.
2. Filtro por mês – O cliente pode acompanhar o consumo mensal das suas APIs. No Painel - Consumo de APIs ele pode ver as requisições do 1° ao último dia do mês, como data de abertura e fechamento do cálculo de requisições do pacote contratado. Mais detalhes no tópico 5. Total Excedido
3. Total de Requisições – Mostra o total de requisições feitas nas APIs no período corrente (mês) selecionados no filtro Mês/Ano. 
   
4. Média Diária de Requisições – Como o pacote faz um controle diário de consumo com base no pacote de APIs do cliente, o cálculo é feito da seguinte forma: MÉDIA(REQUISICOES_DIA), onde a data da requisição está entre o 1º e último dia do mês.
   
5. Total Excedido – Mostra a quantidade de requisições válidas excedidas no mês com base no pacote contratado do 1° ao último dia do mês, sendo descartadas as requisições com resposta [401] (Acesso não autorizado) ou resposta [500-599] (Erros internos no servidor). 
6. Link para Relatório Analítico – Foi disponibilizado um relatório analítico do consumo de APIs. Clique no link que aparece na tela para visualizar o relatório analítico do mês filtrado. Mais detalhes sobre este relatório será apresentado no tópico a seguir.
7. Pacote Contratado – Exibe a quantidade de requisições do pacote contrato por dia.
8. Gráfico - Histograma de Requisições – Exibe com a linha tracejada o pacote contratado de requisições e na linha azul o volume de requisições efetuadas. Nestes números são consideradas todas as requisições (válidas e inválidas).
9. Clique no gráfico para visualizar detalhes: Ao clicar no círculo que representa a quantidade de requisições do dia, o sistema direcionará para o relatório analítico apresentando os detalhes de requisições feitas naquele dia.

Nota! 
Mais informações sobre os tipos de resposta podem ser encontradas no link a seguir:

https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Status.

Esperamos que este artigo tenha ajudado!