DOCS

Utilização da API

Monitorize o volume de chamadas à API da sua organização e a utilização por produto, e exporte o seu histórico de utilização para CSV.

A página Usage do Dashboard mostra como a sua organização está a utilizar a API da Zonos ao longo do tempo. Pode ver o volume total de chamadas, os produtos que mais utiliza e a evolução da utilização de mês para mês — e depois exportar os dados subjacentes para um ficheiro CSV para reconciliação, revisão da faturação ou uma análise mais aprofundada.

Para abri-la, inicie sessão no Dashboard e selecione Usage na navegação à esquerda.

Ler o painel 

No topo da página, dois cartões resumem a sua atividade no período selecionado:

  • Total API calls — O número total de chamadas à API no período selecionado. Quando visualiza a granularidade mensal, este cartão mostra também a variação percentual face ao mês anterior.
  • Most used API — O produto Zonos a que faz chamadas com mais frequência.

Abaixo dos cartões, o gráfico API volume apresenta as suas chamadas ao longo do tempo num gráfico de barras empilhadas, com cores diferentes por produto. A secção API type breakdown, por baixo, lista cada produto com o respetivo número de chamadas e a sua percentagem da utilização total.

Utilize os controlos acima do gráfico para ajustar a vista:

  • Date range — Escolha 1 month, 3 months ou 6 months.
  • Granularity — Agrupe a atividade em intervalos Daily, Weekly ou Monthly.

Que produtos de API são monitorizados 

A utilização é apresentada por produto Zonos, para que possa ver exatamente para onde vão as suas chamadas:

Produto↕Descrição↕
ClassifyPedidos de classificação de códigos SH
Landed CostPedidos de cálculo de direitos aduaneiros, impostos e taxas
Order CompleteEncomendas concluídas através da API da Zonos
Denied PartyPedidos de verificação de partes recusadas (Screen)
Restricted ItemVerificações de restrição de artigos (Restrict)

Exportar a sua utilização para CSV 

Para transferir um CSV do seu histórico de utilização:

  1. Na página Usage, clique em Export.
  2. Na caixa de diálogo Download API usage CSV, escolha um Date range. Selecione uma predefinição — This month, Last month, Last 7 days, Last 30 days, Last 90 days, This quarter, Last quarter, Year to date ou Last year — ou escolha Custom e defina a sua própria Start date e End date.
  3. Em API types, selecione os produtos a incluir. Todos os produtos suportados estão selecionados por predefinição.
  4. Escolha uma Granularity — Daily, Weekly ou Monthly — para controlar a forma como as linhas são agrupadas por data.
  5. Clique em Download.

A caixa de diálogo abre já preenchida com o intervalo de datas e a granularidade apresentados na página, para que possa exportar o que está a ver com um só clique.

O ficheiro exportado contém as seguintes colunas:

Coluna↕Descrição↕
PeriodO intervalo de datas da linha, com base na granularidade escolhida
API TypeO produto Zonos a que as chamadas pertencem
Call CountO número de chamadas à API desse produto nesse período

Nota: Se nenhuma utilização corresponder aos filtros selecionados, não é transferido nenhum ficheiro e o Dashboard informa que não havia nada para exportar. Experimente alargar o intervalo de datas ou selecionar mais tipos de API.

Aviso de migração dos dados de utilização 

A Zonos migrou recentemente para um sistema melhorado de monitorização da utilização da API. Os dados de utilização anteriores à migração podem estar incompletos ou em falta — isto é esperado. Toda a utilização a partir de agora é monitorizada com precisão.

Esta página foi útil?