API de eventos web de servidor a servidor para PBA (Web-S2S)

La implementación de la API requiere las siguientes credenciales disponibles en el panel de control:

• ID de paquete (también conocido como ID del paquete de marca)
• Clave de desarrollador web

Para obtener las credenciales: 

1. En AppsFlyer, en el menú superior, selecciona Mis aplicaciones > Ver paquetes de marcas.
   Aparece la lista de paquetes.
2. Copia y registra lo que corresponda:
   • ID de paquete de marca
   • Clave de desarrollador web

Conceptos básicos de la API Web S2S

 Ejemplo de setCuId de Curl

curl --location --request POST 'https://webs2s.appsflyer.com/v1/bundleId/setcuid' \
--header 'Accept-Encoding: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
	"customerUserId": "1234567890abcdef",
	"afUserId":"9999999-f848-4963-a091-568f0bf9a361",
        "webDevKey" : "99999999-9999-9999-9999-999999999999"}

Los parámetros de carga útil se dividen en identificadores de usuario y parámetros de evento. 

• ID de usuario: debes enviar al menos un parámetro de ID de usuario.
• Evento: envía los parámetros obligatorios y los parámetros opcionales según sea necesario.

Parámetros de identificador de usuario (envía al menos un parámetro)

Parámetros del evento

curl --location --request POST 'https://webs2s.appsflyer.com/v1/bundleId/event' \
--header 'Accept-Encoding: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
	"customerUserId": "1234567890abcdef",
	"afUserId":"9999999-f848-4963-a091-568f0bf9a361",
    "webDevKey" : "99999999-9999-9999-9999-999999999999",
    "ip" : "192.0.2.1",
	"eventType":"EVENT",
	"timestamp" : 1234567890123,
	"eventName":"my_web_event",
	"eventRevenueCurrency" : "EUR",
	"eventRevenue" : 1234.56,
	
		"eventValue": {
		"purchase":{
		 "shoes": "color",
		 "quantity" : "3",
		 "Revenue" : "1234.56",
		 "Currency" : "ZAR"
		}
	}

}'

''' using the requests python package, install using pip install requests  '''
import requests
url = "https://webs2s.appsflyer.com/v1/bundleId/event"
payload = {
    "customerUserId": "1234567890abcdef",
    "afUserId": "9999999-f848-4963-a091-568f0bf9a361",
    "webDevKey": "99999999-9999-9999-9999-999999999999",
    "ip": "192.0.2.1",
    "eventType": "EVENT",
    "timestamp": 1234567890123,
    "eventName": "my_web_event",
    "eventRevenenuCurrency": "EUR",
    "eventRevenue": 1234.56,
    "eventValue":
        {
            "purchase":
            {
                "shoes": "color",
                "quantity": "3",
                "Revenue": "1234.56",
                "Currency": "ZAR"
            }
        }
    }
headers = {
    'Accept-Encoding': 'application/json',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text.encode('utf8'))

A modo de prueba, envía varios eventos como se indica a continuación:

1. Envía un evento.
2. Asegúrate de obtener un código de retorno 200 OK. Si no es así, tome medidas correctivas utilizando los códigos de retorno y los mensajes de error.
3. Espere varias horas después de medianoche UTC para ver el evento reportado en el raw data de PBA. Debes esperar porque los datos de PBA se procesan una vez al día. 

 Para obtener la clave de desarrollador web:

1. En AppsFlyer, ve a la sección Mis aplicaciones.
2. Haz clic en Ver paquetes de marca.

   

3. Copia la clave de desarrollador web requerida. 

• El afUserId es un identificador único, establecido por el SDK web cuando un usuario visita tu sitio por primera vez.
• Si necesitas el afUserId, utiliza uno de los métodos que se indican a continuación.

Obtener el afUserId del encabezado de la cookie HTTP

• El afUserId es enviado por el navegador del visitante cuando visita tu sitio web.
•  Extráelo del encabezado de la cookie HTTP si es necesario.

Ver el afUserId en el navegador del visitante

•  Visualiza el afUserId en el navegador del visitante, con fines de solución de problemas y depuración.
• Para que esté disponible, el visitante tiene que haber visitado primero una página que tenga el SDK web al menos una vez. 
• La cookie que contiene afUserId es una cookie de origen en relación con tu dominio.
• El procedimiento que sigue se preparó utilizando Chrome 81. Puede haber algunas diferencias entre los distintos navegadores y sistemas operativos.

Para obtener el afUserId del navegador del visitante:

1. En tu navegador, ve a tu sitio web.
2. Haz clic con el botón derecho del ratón y selecciona Inspeccionar
   Se abre la ventana de inspección de elementos del navegador.

   

3. Ve a la pestaña (A) Aplicación.
4. En el menú lateral, (B) expande Cookies.
5. Selecciona tu sitio web. Si no aparece, actualiza el navegador.
6. En el (C) filtro, introduce afUserId
   Se muestra el valor de afUserID. 

• Síntoma: Los códigos de retorno HTTP no se devuelven
  Solución: Agregar los servidores de AppsFlyer a la lista de permitidos