Tu guía de la API (API Docs)

Para qué sirve

Tu guía de la API es la documentación que necesitas, tú o tu programador, para enviar leads a la red: la dirección a la que enviarlos, tu token, los campos, ejemplos, las respuestas y los requisitos de cada una de tus campañas. Se genera con tus datos cada vez que la abres.

Quién puede usarlo

Tú, con tu sesión del portal de afiliados. Siempre ves tu propia guía.

Paso a paso

1. Ábrela desde cualquiera de estos sitios (se abre en una pestaña nueva):
   • en el menú, API Docs;
   • en Ofertas (Offers), el botón Descargar Documentación API (pese al nombre, abre la misma página, no descarga un fichero);
   • en la ficha de una oferta por API, el enlace Ver documentación completa de la API.

   

2. Arriba están la dirección a la que se envían los leads, el método (POST) y el formato (JSON); en el apartado 1. Authentication, tu token en el recuadro YOUR SECRET TOKEN: ②.
3. Para guardarla, pulsa 🖨️ Print / Save as PDF ①, arriba a la derecha. Se abre el diálogo de imprimir de tu navegador: elige guardar como PDF. Al imprimir, el botón no sale y las tablas no se parten por la mitad de una fila.

Lo que conviene saber

Tu token es secreto

• El token te identifica en cada lead: quien lo tenga puede enviar leads en tu nombre. Trátalo como una contraseña.
• Sale en el recuadro y también en los ejemplos de la guía, así que el PDF lleva tu token. No lo compartas fuera de tu equipo técnico.
• Desde el portal no se puede cambiar. Si crees que se ha filtrado, avisa a tu red.

Lo que trae la guía

• Está siempre en inglés, aunque tu portal salga en castellano.
• 2. Request Parameters: los campos obligatorios y los opcionales, con su formato. El detalle en castellano está en API de leads: enviar un lead (referencia).
• 3. Example Requests (JSON): un ejemplo mínimo y uno completo. Si tienes más de una campaña, el ejemplo lleva YOUR_CAMPAIGN_ID en vez de un número, para que no se pueda copiar sin más: pon en cada lead el id de su campaña. La guía te dice cuáles son los tuyos, y un lead con el id de otra campaña va al comprador de esa campaña.
• 4. API Responses: las respuestas, con la tabla de mensajes y códigos de error (en castellano, API de leads: mensajes y códigos de error).
• 5. Requirements of your campaigns: lo que exige cada una de tus campañas, cómo trata los duplicados y, si lo tiene, su horario de recepción. Más en API de leads: requisitos, duplicados y horario de cada campaña.
• No recoge todos los campos que admite la API: el del navegador del usuario (user_agent_lead) no sale en la tabla de opcionales. Si una campaña lo exige, sí aparece en su apartado 5.
• El postback no se explica aquí: se configura en Tu perfil: datos de cobro, contraseña y postback.

Vuelve a abrirla cuando cambien tus campañas

• El apartado 5 se genera al abrir la guía con lo que tenga configurado la red en ese momento: requisitos, horario y campañas asignadas. Un PDF guardado se queda como estaba; la red no te avisa de los cambios.
• El pie dice cuándo se generó (Generated automatically by AffiliaTracker Platform on …, con la fecha y la hora).
• El apartado 5 sólo lista tus campañas activas con una asignación activa. Si en Ofertas (Offers) ves una oferta que no sale en la guía, esa campaña no está activa ahora.

Errores frecuentes

Relacionado

• API de leads: enviar un lead (referencia)
• API de leads: mensajes y códigos de error
• API de leads: requisitos, duplicados y horario de cada campaña
• Tus ofertas
• La ficha de una oferta: integración, requisitos, horario y material