Para obtener un token de la API, dirígete a la página de API desde el menú lateral y haz clic en “GENERATE NEW TOKEN”. Desde esa misma página también puedes acceder a la documentación de la API y ver todos los tokens que has utilizado anteriormente.
❗ Nota: Solo puede haber un token válido a la vez. Por lo tanto, una vez que generes uno nuevo, deberás actualizar todas las solicitudes a la API que hayas hecho previamente.
Incluye el token en un parámetro del encabezado llamado X-API-Key:
Endpoints disponibles y URI
Todas las solicitudes se hacen al siguiente URI:
SALDO (BALANCE)
/balance.{format} - Consulta el saldo actual de tu cuenta.
BANNER
/banner/{banner_id}.{format} - Actualiza la actividad de un banner.
/banner/{banner_id}/landings.{format}
Consulta el estado de las páginas de aterrizaje vinculadas a un banner en particular.
CAMPAÑA (CAMPAIGN)
/campaign/{campaign_id}.{format} - (GET) Consulta el estado de una campaña específica.
/campaign/{campaign_id}.{format} - (PATCH) Actualiza la configuración de actividad de una campaña.
/campaign/{campaign_id}/banners.{format} - Consulta el estado de los banners dentro de una campaña específica.
/campaign/{campaign_id}/landings.{format} - Consulta el estado de las páginas de aterrizaje vinculadas a una campaña.
/campaign/{campaign_id}/linking/blacklist.{format} - Consulta las ubicaciones bloqueadas (lista negra) para una campaña específica (no visible en la interfaz de usuario).
/campaign/request.{format} - Crea una nueva solicitud de campaña que será revisada por el equipo de moderación.
/campaign/{campaignId}/update.{format} - Actualiza una campaña existente por su ID.
CAMPAÑAS (CAMPAIGNS)
/campaigns.{format} - Consulta el estado de todas tus campañas.
VINCULACIÓN (LINKING)
/linking/blacklist.{format} - Añade ubicaciones a la lista negra para bloquear tráfico hacia tu campaña.
/linking/blacklist/delete.{format} - Elimina ubicaciones específicas de la lista negra de una campaña.
/linking/blacklist/clean.{format} - Limpia todas las ubicaciones bloqueadas de la lista negra de una campaña específica.
/linking/whitelist.{format} - Añade ubicaciones específicas a la lista blanca para permitir tráfico únicamente desde esas fuentes.
/linking/whitelist/delete.{format} - Elimina ubicaciones específicas de la lista blanca de una campaña.
/campaign/{campaignId}/linking/whitelist.{format} - Consulta todas las ubicaciones en la lista blanca de una campaña.
/campaign/{campaignId}/linking/whitelist/clean.{format} - Elimina todas las ubicaciones de la lista blanca de una campaña.
ESTADÍSTICAS (STATISTICS)
/stats.{format} - Accede a informes detallados sobre el rendimiento de tus campañas.
PUJAS PERSONALIZADAS (CUSTOM-BIDS)
/campaign/{campaignId}/custom_bid.{format} - Consulta la lista de pujas personalizadas para una campaña específica.
/campaign/{campaignId}/custom_bid.{format} - Establece una lista de pujas personalizadas para una campaña.
/campaign/{campaignId}/custom_bid.{format} - Actualiza la lista de pujas personalizadas de una campaña.
/campaign/{campaignId}/custom_bid.{format} - Elimina pujas específicas de la lista de pujas personalizadas de una campaña.
/campaign/{campaignId}/custom_bid/clean.{format} - Limpia todas las pujas personalizadas de una campaña.
Puedes obtener los datos en los siguientes formatos: JSON, XML y CSV. Asegúrate de especificar el formato deseado en la URI.
Ejemplo:
https://api3.adsterratools.com/advertiser/stats.json
Ejemplos de solicitudes para obtener estadísticas de Adsterra a través de la API
Vamos a guiarte a través de algunas solicitudes utilizando Postman, una herramienta popular para pruebas de API. Puedes usarla para entender cómo estructuramos la información y para probar las solicitudes que planeas realizar.
Primero, necesitamos obtener los identificadores de tus campañas desde la siguiente URI:
https://api3.adsterratools.com/advertiser/stats.json?group_by=campaign&start_date=2024-12-01&finish_date=2025-01-15
Podemos usar group_by para obtener las estadísticas de las campañas:
En el cuerpo de la respuesta, podremos ver lo siguiente:
Ahora, tomemos el ID de una campaña del resultado anterior y verifiquemos el estado de las landings vinculadas a un banner específico:
La respuesta:
Posibles errores y cómo solucionarlos
401 — Solicitud no autorizada. Por favor, usa el token disponible en tu panel de control.
403 — Acceso denegado. El token ya no es válido. Por favor, genera un nuevo token.
404 — No encontrado. Asegúrate de que la URI esté escrita correctamente.