DOCS

Uso de la API

Uso de la API

Supervise el volumen de llamadas a la API de su organización y el uso por producto, y exporte su historial de uso a CSV.

La página Usage en Dashboard muestra cómo su organización utiliza la API de Zonos a lo largo del tiempo. Puede ver su volumen total de llamadas, qué productos utiliza más y cómo evoluciona el uso mes a mes, y luego exportar los datos subyacentes a un archivo CSV para conciliación, revisión de facturación o análisis más profundo.

Para abrirla, inicie sesión en Dashboard y seleccione Usage en la navegación izquierda.

Lectura del panel 

En la parte superior de la página, dos tarjetas resumen su actividad para el período seleccionado:

  • Total API calls — El número total de llamadas a la API en el período seleccionado. Cuando ve la granularidad mensual, esta tarjeta también muestra el cambio porcentual respecto al mes anterior.
  • Most used API — El producto de Zonos que llama con más frecuencia.

Debajo de las tarjetas, el gráfico API volume representa sus llamadas a lo largo del tiempo como un gráfico de barras apiladas, codificado por colores según el producto. El desglose API type breakdown debajo enumera cada producto con su recuento de llamadas y su proporción del uso total.

Use los controles sobre el gráfico para ajustar la vista:

  • Date range — Elija 1 month, 3 months o 6 months.
  • Granularity — Agrupe la actividad en intervalos Daily, Weekly o Monthly.

Qué productos de API se rastrean 

El uso se informa por producto de Zonos para que pueda ver exactamente a dónde van sus llamadas:

ProductDescription
ClassifySolicitudes de clasificación de códigos HS
Landed CostSolicitudes de cálculo de derechos, impuestos y tasas
Order CompletePedidos completados a través de la API de Zonos
Denied PartySolicitudes de screening de partes denegadas (Screen)
Restricted ItemComprobaciones de restricción de artículos (Restrict)

Exporte su uso a CSV 

Para descargar un CSV de su historial de uso:

  1. En la página Usage, haga clic en Export.
  2. En el cuadro de diálogo Download API usage CSV, elija un Date range. Seleccione un preajuste — This month, Last month, Last 7 days, Last 30 days, Last 90 days, This quarter, Last quarter, Year to date o Last year — o elija Custom y establezca su propia Start date y End date.
  3. En API types, seleccione qué productos incluir. Todos los productos compatibles están seleccionados de forma predeterminada.
  4. Elija una GranularityDaily, Weekly o Monthly — para controlar cómo se agrupan las filas por fecha.
  5. Haga clic en Download.

El cuadro de diálogo se abre prellenado con el rango de fechas y la granularidad que se muestran actualmente en la página, para que pueda exportar lo que está viendo con un solo clic.

El archivo exportado contiene las siguientes columnas:

ColumnDescription
PeriodEl intervalo de fechas de la fila, según la granularidad seleccionada
API TypeEl producto de Zonos al que pertenecen las llamadas
Call CountEl número de llamadas a la API para ese producto en ese período

Note: Si ningún uso coincide con los filtros seleccionados, no se descarga ningún archivo y Dashboard le informa que no había nada que exportar. Intente ampliar el rango de fechas o seleccionar más tipos de API.

Aviso de migración de datos de uso 

Zonos migró recientemente a un sistema mejorado de seguimiento del uso de la API. Los datos de uso anteriores a la migración pueden estar incompletos o faltar — esto es esperado. Todo el uso a partir de ahora se rastrea con precisión.

¿Fue útil esta página?