Primeros pasos con la API de leads

Para qué sirve

Es el recorrido para quien programa la integración de un afiliado con la red: qué tener antes, dónde están los datos y cómo probar sin entregar ningún lead por error. Cada paso enlaza a su referencia.

Paso a paso

1. Pide a tu red el alta y tus campañas

Tu token se crea cuando la red te da de alta como afiliado. Además, la red tiene que asignarte campañas y tenerlas activas: hasta entonces, cualquier lead que pase las comprobaciones de formato recibe no_campaign_available. Las asignaciones las hace la red; tú no puedes crearlas.

2. Abre tu guía de integración

En el portal de afiliados, pulsa API Docs en el menú lateral, o Descargar Documentación API en la página Ofertas Disponibles (entrada Ofertas (Offers) del menú). La guía se abre en el navegador, en inglés; para tener una copia, imprímela o guárdala en PDF con el botón de la propia página.

En ella tienes:

• la dirección y el método, arriba: https://app.affiliatracker.com/api/lead, POST, JSON;
• tu token, en el apartado 1. Authentication, en el recuadro YOUR SECRET TOKEN:;
• los parámetros y ejemplos, en los apartados 2 y 3;
• las respuestas y errores, en el 4;
• lo que pide cada campaña, en el 5.

3. Mira qué pide cada campaña

En el apartado 5. Requirements of your campaigns sale cada campaña activa que tienes asignada, con su número, los datos que exige, cómo cuenta los duplicados y su horario de recepción. El número también sale en las ofertas del portal. Detalle: API de leads: requisitos, duplicados y horario de cada campaña.

4. Prueba tu código sin entregar nada

No hay entorno de pruebas, así que prueba con peticiones que el servidor rechaza antes de guardar el lead. Te sirven para comprobar que tu código envía bien y que lee status y code.

JSON inválido. Manda un cuerpo que no sea JSON, por ejemplo esto no es json. Respuesta, con HTTP 400:

{"status":"error","message":"Invalid JSON Payload","code":"invalid_json"}

Un campo que falta. Manda tu petición sin country_lead:

{"token_affiliate":"TU_TOKEN","id_campaign":12,"id_source":1,"email_lead":"ana.martin@ejemplo.test","ip_lead":"203.0.113.45"}

Respuesta, con HTTP 200:

{"status":"error","message":"The country format is incorrect.","code":"missing_field","field":"country_lead"}

Un token que no existe. Manda todos los campos bien, pero con un token inventado (TOKEN-INEXISTENTE), nunca el tuyo. Respuesta, con HTTP 200:

{"status":"error","message":"The affiliate does not exist.","code":"unknown_affiliate"}

Ojo: una petición completa y correcta con tu token de verdad no es una prueba: se guarda y se entrega al comprador en ese momento, y si la acepta cuenta como venta.

5. Envía el primer lead y lee la respuesta

Cuando todo esté listo, envía un lead real con los datos que pide su campaña. La respuesta llega casi siempre con HTTP 200: status dice si se aceptó y, si no, code dice por qué. Cómo se monta la petición: API de leads: enviar un lead (referencia). Qué significa cada código y cuándo reenviar: API de leads: mensajes y códigos de error.

6. Si quieres, configura tu postback

Para que tu tracker se entere de cada venta, pon tu dirección en Mi Perfil › Global Postback (S2S) y manda tu click ID en subid_lead: Postback: avisar a tu sistema de cada venta.

Lo que conviene saber

• Guarda tu token en secreto. Va dentro del cuerpo de cada petición e identifica tus leads. Llama a la API desde tu servidor, nunca desde una página web, para que no llegue al navegador de tus usuarios. Si crees que se ha filtrado, habla con tu red.
• La guía se calcula al abrirla. Si la red cambia los requisitos o el horario de una campaña, una copia guardada en PDF no se actualiza: vuelve a abrirla.
• No hay alta de la integración ni un registro de tus peticiones en el portal: un lead que se rechaza antes de guardarse sólo lo ves en la respuesta.

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
• Postback: avisar a tu sistema de cada venta
• Tu guía de la API (API Docs)
• Primeros pasos en el portal de afiliados