Referencia de la API del punto final SESSION

Caso de uso de servidor a servidor

La API REST de Singular permite la integración directa de servidor a servidor como alternativa al SDK. El LAUNCH o Session Endpoint permite el seguimiento de sesiones en sus aplicaciones. Cuando su aplicación envía datos específicos del dispositivo a su servidor, que a su vez transmite los datos a los servidores de Singular, la plataforma de Singular procesa esta información para: Install Attribution, ReEngagement Attribution y Retention Metrics. Estos datos procesados rellenan automáticamente sus informes, registros de exportación y postbacks configurados, proporcionando análisis completos para sus campañas de marketing.

Mientras que el SDK recopila automáticamente los datos del dispositivo y de la aplicación, el enfoque S2S requiere que usted:

Recopilar los datos necesarios de su aplicación
Reenvíe estos datos a su servidor
Enviarlos a Singular a través de REST API
Devuelva la respuesta de Singular a la aplicación

Puntos clave

Flexibilidad: Control total sobre la recogida y transmisión de datos
Paridad de funciones: Compatible con todas las funciones del SDK si se proporcionan los datos adecuados.
Ruta de integración: Cliente → Su servidor → API singular
Procesamiento en tiempo real: Una solicitud cada vez, sin procesamiento por lotes
Flujo de datos secuencial: Los eventos deben procesarse en orden cronológico
Deduplicación de datos: Singular no deduplica los datos recibidos. Se recomienda enviar una (1) solicitud con éxito y guardar los registros en caso de que deba repetirse una solicitud.
Validación de datos: Los datos a nivel de dispositivo son permanentes y no pueden borrarse una vez introducidos. Realice una validación exhaustiva de los datos antes de enviarlos a Singular para garantizar su exactitud.

Gestión de sesiones

El punto final LAUNCH se utiliza para notificar a Singular de un evento App Open para una nueva sesión de usuario.

La inicialización de la sesión (solicitud de lanzamiento) es necesaria para:
- Nuevas instalaciones de aplicaciones
- Lanzamiento de aplicaciones desde un estado finalizado
- Aplicación que vuelve a primer plano desde segundo plano
La sesión debe establecerse antes de cualquier seguimiento de eventos
Un orden de sesión no válido provocará incoherencias en los datos.
Se recomienda implementar un tiempo de espera de sesión y sólo enviar a Singular la notificación de SESIÓN si la aplicación no se ha utilizado en el último minuto. Si un usuario entra en segundo plano en la aplicación y luego la pone en primer plano en 1 minuto o menos, no se activará una SESIÓN Singular, pero si entra en primer plano en más de 1 minuto, se activará una SESIÓN.
Para soportar deep linking, siempre se debe enviar una Sesión para la App Open con el openURL en el parámetro 'open_uri'.

Cómo empezar

La documentación del endpoint Session proporciona:

Parámetros obligatorios
Parámetros opcionales
Ejemplos de solicitudes
Códigos de respuesta y errores
Pruebas de sesión

Asegúrese de revisar las opciones avanzadas de la integración Servidor a Servidor (S2S) de Singular que requieren que el Punto Final de Notificación de Sesión incluya parámetros adicionales. Conozca las Opciones Avanzadas aquí.

Notificación de sesiones

La integración más básica con Singular consiste en notificar a Singular cuando se produce una sesión de usuario, lo que permite a Singular activar varios procesos internos:

Si es la primera sesión para la aplicación en el dispositivo específico, Singular reconoce una nueva instalación y activa el proceso de atribución de instalación.
Si la sesión se califica como sesión de reenganche, Singular activa el proceso de atribución de reenganche (más información en las preguntas frecuentes sobre reenganche).
De lo contrario, Singular la marca como una sesión, que se utiliza para realizar un seguimiento de la actividad del usuario y las métricas de retención.

La sincronización de una solicitud de sesión y las posteriores solicitudes de eventos a los servidores de Singular es fundamental:

Debe recibirse una única sesión antes de cualquier evento.
Por ejemplo, el SDK de Singular activará una sesión en la apertura de la aplicación cuando el usuario comience a utilizarla. Si el usuario deja la aplicación en segundo plano durante un largo periodo de tiempo (más de 1 minuto), la sesión expirará. Se enviará otra sesión cuando la aplicación vuelva al primer plano. Se recomienda utilizar eventos del ciclo de vida de la aplicación y un temporizador para ayudar a gestionar la sesión y regular las solicitudes de sesión a Singular.
Los eventos que se produzcan en la aplicación deben enviarse en tiempo real y después de su respectiva sesión.

Sesión API Endpoint

Método HTTP y punto final de sesión

GET https://s2s.singular.net/api/v1/launch

Parámetros requeridos

La siguiente tabla enumera los parámetros requeridos que soporta este endpoint. Todos los parámetros enumerados son parámetros de consulta.

GET /api/v1/launch?param1=value1&param2=value2

Todos los parámetros obligatorios deben incluirse en las solicitudes de la API de SESIÓN.
Los parámetros deben seguir el formato y los tipos de datos especificados

Parámetros requeridos
Clave API
Parámetro	Descripción
`a`	`string` El parámetro a especifica la clave Singular SDK Key. Obtenga la clave SDK en la interfaz de Singular, en Herramientas de desarrollo del menú principal. Nota: No utilice la clave API de generación de informes, ya que se rechazarán los datos. Valor de ejemplo: `sdkKey_afdadsf7asf56`
Parámetros del identificador del dispositivo
Parámetro	Descripción
`idfa` Plataformas soportadas: iOS	`string` El parámetro idfa especifica el Identificador para Anunciantes (IDFA) que ayuda a los anunciantes a rastrear y atribuir las acciones de los usuarios (por ejemplo, clics en anuncios, instalaciones de aplicaciones) a campañas específicas, lo que permite una orientación precisa de los anuncios y la optimización de las campañas. A partir de iOS 14.5, los usuarios deben optar por el marco App Tracking Transparency (ATT) para que las aplicaciones puedan acceder al IDFA. Si los usuarios no optan por el IDFA, este no estará disponible, lo que limitará las capacidades de seguimiento. Si el IDFA no está disponible, omita el parámetro de la solicitud. No pase NULL o una cadena vacía en la petición. Cómo recuperar el Identificador IDFA Valor de ejemplo: `DFC5A647-9043-4699-B2A5-76F03A97064B`
Parámetro	Descripción
`idfv` Plataformas soportadas: iOS	`string` El parámetro idfv especifica el Identificador de Vendedores (IDFV), un identificador único asignado por Apple a un dispositivo, que es específico de un vendedor o desarrollador concreto. Permanece constante en todas las aplicaciones del mismo proveedor en un dispositivo determinado, lo que permite al proveedor realizar un seguimiento del comportamiento y las interacciones del usuario en todo su ecosistema de aplicaciones sin identificar al usuario personalmente. El IDFV es obligatorio en todas las solicitudes, independientemente del estado de ATT o de la presencia del IDFA. Cómo recuperar el identificador IDFV Valor de ejemplo: `21DB6612-09B3-4ECC-84AC-B353B0AF1334`
Parámetro	Descripción
`aifa` Plataformas soportadas: Android (Dispositivos Google Play)	`string` El parámetro aifa especifica el identificador de publicidad de Google (GAID), también conocido como AIFA en singular o Android Advertising ID (AAID). Este identificador es un identificador único y reajustable por el usuario asignado a los dispositivos Android. Ayuda a los anunciantes y a los desarrolladores de aplicaciones a rastrear y atribuir las acciones de los usuarios (por ejemplo, clics en anuncios, instalaciones de aplicaciones) en las aplicaciones a campañas específicas, lo que permite una orientación precisa de los anuncios y la optimización de las campañas, al tiempo que se mantiene la privacidad del usuario. Si la AIFA no está disponible, omita el parámetro de la solicitud. Solo se requiere en dispositivos Google Play. Omita el parámetro en dispositivos que no sean de Google Play. No pase NULL o una cadena vacía en la solicitud. Cómo recuperar el identificador AIFA Valor de ejemplo: `8ecd7512-2864-440c-93f3-a3cabe62525b`
Parámetro	Descripción
`asid` Plataformas soportadas: Android (Dispositivos Google Play)	`string` El parámetro asid especifica el Android App Set ID. El ASID permite a los desarrolladores realizar un seguimiento de los usuarios en sus propias aplicaciones respetando su privacidad. Es especialmente útil para el análisis y la prevención del fraude, pero no puede utilizarse con fines publicitarios, como anuncios personalizados o mediciones. El ASID es obligatorio en todas las solicitudes de dispositivos Google Play, independientemente de la presencia de GAID/AIFA. Omita el parámetro en dispositivos que no sean de Google Play. No pase NULL o una cadena vacía en la solicitud. Cómo recuperar el identificador ASID Valor de ejemplo: `edee92a2-7b2f-45f4-a509-840f170fc6d9`
Parámetro	Descripción
`amid` Plataformas soportadas: Android (Dispositivos Amazon sin Google Play Services)	`string` El parámetro amid especifica que el ID de publicidad es un identificador único y reajustable por el usuario que ayuda a proteger su privacidad. Si recopilas información sobre el comportamiento de un usuario para mostrar anuncios basados en intereses o para generar análisis, debes utilizar el ID de publicidad; no se puede utilizar ningún otro identificador o método de seguimiento. Los usuarios pueden restablecer el identificador de publicidad o excluirse totalmente de los anuncios basados en intereses. El AMID es obligatorio en todas las solicitudes de dispositivos de Amazon sin Google Play Services. Omita el parámetro si el AMID no está disponible. No pase NULL o una cadena vacía en la solicitud. Cómo recuperar el identificador AMID Valor de ejemplo: `df07c7dc-cea7-4a89-b328-810ff5acb15d`
Parámetro	Descripción
`oaid` Plataformas soportadas: Android (Dispositivos fabricados en China sin Google Play Services)	`string` El parámetro oaid especifica Open Advertising Identifier (OAID). El OAID es un identificador único y anónimo utilizado con fines publicitarios en dispositivos Android, especialmente los fabricados en China. Fue introducido por la Mobile Security Alliance (MSA) como alternativa al identificador de publicidad de Google (GAID) para dispositivos en los que los servicios de Google Play no están disponibles o no son compatibles, como en el mercado chino. El OAID se utiliza principalmente para la atribución de publicidad y el seguimiento de usuarios en entornos en los que los servicios de Google Play están restringidos, lo que permite a los anunciantes y desarrolladores rastrear el comportamiento de los usuarios manteniendo el anonimato. El OAID está disponible en la mayoría de los dispositivos Android fabricados en China, incluidos los de marcas como Huawei, Xiaomi y otras. Se puede acceder a él mediante el SDK MSA o Huawei Mobile Services (HMS). El OAID es necesario en los dispositivos Android fabricados en China sin Google Play Services. Omita el parámetro si el OAID no está disponible. No pase NULL o una cadena vacía en la solicitud. Cómo recuperar el identificador OAID Valor de ejemplo: `01234567-89abc-defe-dcba-987654321012`
Parámetro	Descripción
`andi` Plataformas soportadas: Android (Dispositivos sin Google Play)	`string` El parámetro andi especifica el ID de Android, que es un identificador único de 64 bits generado por el sistema operativo Android cuando se configura un dispositivo por primera vez. Está diseñado para ser persistente durante toda la vida útil del dispositivo, pero puede restablecerse en determinadas condiciones, como un restablecimiento de fábrica. El Android ID es único para cada dispositivo y, a partir de Android 8.0 (Oreo), tiene un alcance por app y por usuario. Esto significa que diferentes aplicaciones en el mismo dispositivo recibirán diferentes Android ID a menos que compartan la misma clave de firma. El Android ID permanece constante a menos que el dispositivo se restablezca de fábrica o si se desinstala y se vuelve a instalar una aplicación tras una actualización OTA (over-the-air). Está prohibido utilizar el ANDI en dispositivos Google Play. Utilice los identificadores AIFA y ASID mencionados anteriormente. El ANDI sólo puede enviarse a Singular si no se dispone de otros identificadores y la aplicación no está alojada en Google Play Store. Omita el parámetro si hay otros identificadores disponibles. No pase NULL o una cadena vacía en la solicitud. Cómo recuperar el identificador ANDI Valor de ejemplo: `fc8d449516de0dfb`
Parámetro	Descripción
`sdid` Plataformas soportadas: PC Xbox Playstation Nintendo MetaQuest CTV	`string` El parámetro sdid especifica el Singular Device ID. Este valor es un UUIDv4 generado por el cliente que representa una instalación de aplicación única. Este es el único identificador de dispositivo utilizado para aplicaciones de PC y consola. Valor de ejemplo: `40009df0-d618-4d81-9da1-cbb3337b8dec`
Parámetro	Descripción
`sing` Plataformas soportadas: Restringido para casos de uso especiales Póngase en contacto con su ingeniero de soluciones o CSM para obtener más información	`string` El parámetro sing está restringido a clientes Enterprise y especifica un identificador definido por el Cliente. Sólo se utiliza en usos especiales en los que el resto de identificadores no están disponibles. El ingeniero de soluciones de Singular debe habilitar este identificador para cada aplicación. Valor de ejemplo: `da534a95-1b1b-47d4-94b6-07955ec85177`
Parámetros del dispositivo
Parámetro	Descripción
`p`	`string` El parámetro p especifica la plataforma de la App. La siguiente lista contiene los valores permitidos del parámetro que distinguen entre mayúsculas y minúsculas : Android iOS PC Xbox Playstation Nintendo MetaQuest CTV Valor de ejemplo: `Android`
Parámetro	Descripción
`ip`	`string` El parámetro ip especifica la dirección IP pública (IPV4) del dispositivo. No se admite IPV6. Valor de ejemplo: `172.58.29.235`
Parámetro	Descripción
`ve`	`string` El parámetro ve especifica la versión del sistema operativo del dispositivo en el momento de la sesión. Valor de ejemplo: `9.2`
Parámetro	Descripción
`ma` Plataformas soportadas: Android iOS	`string` El parámetro ma especifica la Marca del hardware del dispositivo, normalmente el nombre de cara al consumidor. Este parámetro debe utilizarse con el parámetro model. Cómo recuperar la marca del dispositivo Ejemplos: `Samsung, LG, Apple`
Parámetro	Descripción
`mo` Plataformas soportadas: Android iOS	`string` El parámetro mo especifica el Modelo del hardware del dispositivo. Este parámetro debe utilizarse con el parámetro make. Cómo recuperar el modelo del dispositivo Ejemplos: `iPhone 4S, Galaxy SIII`
Parámetro	Descripción
`lc` Plataformas soportadas: Android iOS	`string` El parámetro lc especifica la etiqueta de configuración regional IETF para el dispositivo, utilizando un código de idioma y país de dos letras separado por un guión bajo. Cómo recuperar la configuración regional del dispositivo Valor de ejemplo: `en_US`
Parámetro	Descripción
`bd` Plataformas soportadas: Android iOS	`string` El parámetro bd especifica la Build del dispositivo, codificada mediante URL. Cómo recuperar la Build del dispositivo Valor de ejemplo: `Build%2F13D15`
Parámetros de aplicación
Parámetro	Descripción
`i`	`string` El parámetro i especifica el identificador de la aplicación. Este es el nombre del paquete para Android o el ID del paquete para iOS o de su aplicación. los valores de los parámetros distinguen entre mayúsculas y minúsculas : Package Name para Android Bundle ID para iOS Su identificador designado para PC, Xbox, Playstation, Nintendo, MetaQuest o CTV Valor de ejemplo: `com.singular.app`
Parámetro	Descripción
`app_v`	`string` El parámetro app_v especifica la Versión de la Aplicación. Ejemplos: `1.2.3`
Parámetro	Descripción
`install`	`string` El parámetro install especifica si esta sesión representa la primera sesión después de una instalación o reinstalación. Pase'true' si la sesión fue la primera después de instalar la aplicación o'false' si la aplicación ya está instalada y esta es una sesión posterior o una aplicación abierta. Este parámetro es necesario para las capacidades de seguimiento de Reinstalación. Ejemplos: `true`
Parámetro	Descripción
`install_time` Plataformas soportadas: Android iOS	`int` El parámetro install_time especifica la hora de la primera instalación de la aplicación como hora UNIX. Para recuperar este valor, utilice el enlace de la plataforma. Valor de ejemplo: `1510040127`
Parámetro	Descripción
`update_time` Plataformas soportadas: Android iOS	`int` El parámetro update_time especifica la hora de la última actualización de la aplicación como hora UNIX. Para recuperar este valor, utilice el enlace de la plataforma. Valor de ejemplo: `1510040127`
Parámetro	Descripción
`att_authorization_status` Plataformas soportadas: iOS	`int` El parámetro att_authorization_status especifica el código de estado de App Tracking Transparency(ATT). A partir de iOS 14.5, se requiere el indicador App Tracking Transparency (ATT) para acceder al identificador IDFA. Nota: Incluso si no implementa el prompt ATT, requerimos que pase el estado de autorización ATT con el valor'0', indicando "indeterminado". Los valores soportados son: 0 - Indeterminado. 1 - Restringido, el usuario ha deshabilitado el seguimiento de la aplicación. 2 - Denegado, el usuario denegó la autorización. 3 - Autorizado, el usuario ha concedido la autorización. Ejemplos: `3`
Parámetros de fraude
Parámetro	Descripción
`install_source` Plataformas soportadas: Android PC	`string` El parámetro install_source especifica el nombre del paquete fuente de instalación en Android. Los valores recomendados para la fuente de instalación en PC es la tienda de instalación. Los nombres de tienda de instalación admitidos para PC incluyen: steam epic microsoftstore humblestore gog autodistribuido Ejemplo para Android (Google Play Store): `com.vending.android`
Parámetro	Descripción
`install_receipt` Plataformas soportadas: iOS	`string` El parámetro install_receipt especifica el recibo recibido de la instalación. Aprenda a recuperarlo en Recibo de instalación de iOS Ejemplo de una cadena de recibo codificada en base64 de iOS: `MIJF9wYJKoZIhvcNAQcCoIJF6DCCReQCAQExCzAJBgUrDgMCGgUAMII1mAYJKoZIhvcNAQcBoII1iQSCNYUxgjWBMAoCAQgCAQEEAhYAMAoCARQCAQEEAgwAMAsCAQECAQEEAwIBADALAgELAgEBBAMCAQAwCwIBDwIBAQQDAgEAMAsCARACAQEEAwIBADALAgEZAgEBBAMCAQMwDAIBAwIBAQQEDAIyNTAMAgEKAgEBBAQWAjQrMAwCAQ4CAQEEBAICAM8wDQIBDQIBAQQFAgMCIuAwDQIBEwIBAQQFDAMxLjAwDgIBCQIBAQQGAgRQMjU1`
Parámetros Deeplinking
Parámetro	Descripción
`openuri` Plataformas soportadas: Android iOS	`URL-encoded string` El parámetro openuri especifica si la aplicación se abrió a través de un enlace profundo, un enlace universal de iOS o un enlace de aplicación de Android, y debe proporcionar el valor de la URL abierta codificada. URL abierta: `myapp://home/page?queryparam1=value1&queryparam2=value2` Valor de ejemplo: `myapp%3A%2F%2Fhome%2Fpage%3Fqueryparam1%3Dvalue1%26queryparam2%3Dvalue2`
Parámetro	Descripción
`ddl_enabled` Plataformas soportadas: Android iOS	`string` El parámetro ddl_enabled especifica si la aplicación está habilitada para soportar enlaces profundos diferidos. Pasa'true' si el servidor espera que se devuelva una URL de enlace profundo diferido o'false' en caso contrario. Valor de ejemplo: `true` Ejemplo Respuesta: `{ "deferred_deeplink": "myapp://deferred-deeplink", "status": "ok", "deferred_passthrough": "passthroughvalue" }`
Parámetro	Descripción
`singular_link_resolve_required` Plataformas soportadas: Android iOS	`string` El parámetro singular_link_resolve_required se utiliza para resolver un enlace corto Singular. Debe enviarse con un valor en 'openuri' que sea un enlace corto Singular. Pase'true' si el servidor espera que se devuelva el enlace corto expandido (enlace largo) o'false' en caso contrario. Véase la gestión de enlaces cortos. Valor de ejemplo: `true` Ejemplo Respuesta: `{ "status":"ok", "resolved_singular_link":"https://myapp.sng.link/A59c0/nha7?_dl=myapp%3A%2F%2Fdeeplink&_ddl=myapp%3A%2F%2Fdeferred-deeplink&_p=passthroughvalue" }`
Parámetros avanzados de atribución
Parámetro	Descripción
`install_ref` Plataformas soportadas: Android (Dispositivos Google Play)	`JSON URL-encoded string` El parámetro install_ref especifica si la información de referencia de instalación de Google. El referente de instalación contiene información sobre quién envió a un usuario a Google Play Store. Cuando el referente de instalación está disponible para Singular, proporciona la forma más precisa de atribuir instalaciones. Recupere este valor y páselo a Singular en la primera llamada de notificación de sesión. `{ "installBeginTimestampSeconds":"1568939453", "referrer":"utm_source=google-play&utm_medium=organic", "clickTimestampSeconds":"0", "referrer_source":"service", "current_device_time":"1568944524" }` Es necesario para algunas funciones importantes de Singular, como recibir datos de Facebook en nuestras exportaciones a nivel de usuario, compartirlos con destinos de datos y enviar postbacks. Google Play recopila información de referencia cuando un usuario llega a la tienda. Si el usuario instala más tarde la aplicación a la que fue dirigido, Google Play pone la información a disposición de la aplicación. Para obtener más información, consulte la documentación para desarrolladores de Google. Valor de ejemplo: `%7B%22installBeginTimestampSeconds%22%3A%221568939453%22%2C%22referrer%22%3A%22utm_source%3Dgoogle-play%26amp%3Butm_medium%3Dorganic%22%2C%22clickTimestampSeconds%22%3A%220%22%2C%22referrer_source%22%3A%22service%22%2C%22current_device_time%22%3A%221568944524%22%7D`
Parámetro	Descripción
`meta_ref` Plataformas soportadas: Android (Dispositivos Google Play)	`JSON URL-encoded string` El parámetro meta_ref especifica el "Meta Referrer", que es una solución de medición específica de Android introducida por Facebook para permitir a los anunciantes acceder a datos de atribución granulares a nivel de usuario para las instalaciones de aplicaciones de Android (consulta las políticas de datos de Facebook). Consiste en implementar las tecnologías "Google Play Install Referrer" (ver "Pasar Google Install Referrer") y "Meta Install Referrer" para la medición de instalaciones de aplicaciones. Más información sobre Meta Referrer en las preguntas frecuentes sobre el tema. `{ "install_referrer": { "utm_source":"apps.facebook.com", "utm_campaign": "fb4a", "utm_content": { "source":{ "data":"c7e6b890bf18a059c2185650bdb1af3dced7...", "nonce":"24859720343e2381daee9f39ae61" }, "app":533744218636280, "t":1731181327 }, "is_ct":1, "actual_timestamp":1731181444, } }` Valor de ejemplo: `%7B%22install_referrer%22%3A%7B%22utm_source%22%3A%22apps.facebook.com%22%2C%22utm_campaign%22%3A%22fb4a%22%2C%22utm_content%22%3A%7B%22source%22%3A%7B%22data%22%3A%22c7e6b890bf18a059c2185650bdb1af3dced7...%22%2C%22nonce%22%3A%2224859720343e2381daee9f39ae61%22%7D%2C%22app%22%3A533744218636280%2C%22t%22%3A1731181327%7D%2C%22is_ct%22%3A1%2C%22actual_timestamp%22%3A1731181444%2C%7D%7D`
Parámetro	Descripción
`attribution_token` Plataformas soportadas: iOS	`string` El parámetro attribution_token especifica el token de atribución de Apple Search Ads recuperado en iOS 14.3+ a través del marco AdServices. Recupere el token de atribución mediante attributionToken() en cuanto la aplicación se inicialice por primera vez tras una instalación o reinstalación. Valor de ejemplo: KztLg%2FIkNsWDMuBMOU%2BySnkPU5myJb4OFmeaMUE%2BTqQJP1HWL%2FBdpQKNHSnghf0uQpWDsdNcoWHHlXzrRta22Aww4QsUdPGKLwAAAVADAAAAwgAAAIAOMB3LOGJVmcso4G42C3bF8API7suoQgqrM9xfbMKtjpn0anD4Xca2Ma8fMa%2FZLBqWalHYmm58zs4bH1XUDtBcSex1d80D4AhnnPoSYFukr%2ACfLCEnT2lHurPb5cPPQ17ewCd3ctuuZYGHuvV66AkU1ExJUguciTXTNEgY%2Fc19rQAAAB%2BF8udKcAQxkREhEtyGQGRUFydziffiLHBN7bXKSHPFAAAAnwGYh9H%2BPP4rEQGnbnTiQUnkfqgfKQAAAIYCCLjE6nnxqwDQPb4%2FF0Wve%2FVnSwwUxYGsi2a3V5dioUgCzty2kAG8kUsNjk0rU0Z0UrOhvCR%2FGfLXQv7HsMIZlbeKoHast6%2BXfiFsA2x244gztybPDecoGAvsmOeBKxjJqPDGqYxIpBgGaggGg1wonia%2BhxqjcLpEKG%2F%2F%2FEOZb3Jdf%2FaN%2FQABBEkLAAA%3D

Cuerpo de la petición

No proporcione un cuerpo de solicitud cuando llame a este método. La petición debe enviarse utilizando el método GET con parámetros de consulta.

Ejemplos de solicitud

Los siguientes ejemplos de código pueden no representar todos los parámetros soportados. Cuando implemente la petición asegúrese de incluir todos los parámetros requeridos como se indica arriba, y valide que se están pasando los valores correctos antes de enviar datos desde una instancia de producción. Se recomienda utilizar un único parámetro `i` (identificador de aplicación) para el desarrollo y las pruebas.

PYTHON

import requests

params = {
    'a': 'sdk_key_here',
    'p': 'Android',
    'i': 'com.singular.app',
    'ip': '10.1.2.3',
    've': '9.2',
    'ma': 'samsung',
    'mo': 'SM-G935F',
    'lc': 'en_US',
    'aifa': '8ecd7512-2864-440c-93f3-a3cabe62525b',
    'asid': 'edee92a2-7b2f-45f4-a509-840f170fc6d9',
    'install': 'true',
    'n': 'MyCoolAppName',
    'bd': 'Build/13D15',
    'app_v': '1.2.3',
    'openuri': 'myapp://home/page?queryparam1=value1',
    'ddl_enabled': 'true',
    'install_source': 'com.android.vending',
    'install_time': 1510040127,
    'update_time': 1510090877
}

response = requests.get('https://s2s.singular.net/api/v1/launch', params=params)
print(response.json())

CURL

curl -G "https://s2s.singular.net/api/v1/launch" \
  --data-urlencode "a=sdk_key_here" \
  --data-urlencode "p=Android" \
  --data-urlencode "i=com.singular.app" \
  --data-urlencode "ip=10.1.2.3" \
  --data-urlencode "ve=9.2" \
  --data-urlencode "ma=samsung" \
  --data-urlencode "mo=SM-G935F" \
  --data-urlencode "lc=en_US" \
  --data-urlencode "aifa=8ecd7512-2864-440c-93f3-a3cabe62525b" \
  --data-urlencode "asid=edee92a2-7b2f-45f4-a509-840f170fc6d9" \
  --data-urlencode "install=true" \
  --data-urlencode "n=MyCoolAppName" \
  --data-urlencode "bd=Build/13D15" \
  --data-urlencode "app_v=1.2.3" \
  --data-urlencode "openuri=myapp://home/page?queryparam1=value1" \
  --data-urlencode "ddl_enabled=true" \
  --data-urlencode "install_source=com.android.vending" \
  --data-urlencode "install_time=1510040127" \
  --data-urlencode "update_time=1510090877"

HTTP

GET /api/v1/launch
    ?a=sdk_key_here
    &p=Android
    &i=com.singular.app
    &ip=10.1.2.3
    &ve=9.2
    &ma=samsung
    &mo=SM-G935F
    &lc=en_US
    &aifa=8ecd7512-2864-440c-93f3-a3cabe62525b
    &asid=edee92a2-7b2f-45f4-a509-840f170fc6d9
    &install=true
    &n=MyCoolAppName
    &bd=Build%2F13D15
    &app_v=1.2.3
    &openuri=myapp%3A%2F%2Fhome%2Fpage%3Fqueryparam1%3Dvalue1
    &ddl_enabled=true
    &install_source=com.android.vending
    &install_time=1510040127
    &update_time=1510090877 HTTP/1.1
Host: s2s.singular.net
Accept: application/json

JAVA Ejemplo

// Base URL

String baseUrl = "https://s2s.singular.net/api/v1/launch";

// Parameters

Map < String, String > params = new HashMap < > ();
params.put("a", "sdk_key_here");
params.put("p", "Android");
params.put("i", "com.singular.app");
params.put("ip", "10.1.2.3");
params.put("ve", "9.2");
params.put("ma", "samsung");
params.put("mo", "SM-G935F");
params.put("lc", "en_US");
params.put("aifa", "8ecd7512-2864-440c-93f3-a3cabe62525b");
params.put("asid", "edee92a2-7b2f-45f4-a509-840f170fc6d9");
params.put("install", "true");
params.put("n", "MyCoolAppName");
params.put("bd", "Build/13D15");
params.put("app_v", "1.2.3");
params.put("openuri", "myapp://home/page?queryparam1=value1");
params.put("ddl_enabled", "true");
params.put("install_source", "com.android.vending");
params.put("install_time", "1510040127");
params.put("update_time", "1510090877");

// Build URL with encoded parameters

StringBuilder urlBuilder = new StringBuilder(baseUrl);
urlBuilder.append('?');

for (Map.Entry < String, String > entry: params.entrySet()) {
    if (urlBuilder.length() > baseUrl.length() + 1) {
        urlBuilder.append('&');
    }
    urlBuilder.append(URLEncoder.encode(entry.getKey(), StandardCharsets.UTF_8))
        .append('=')
        .append(URLEncoder.encode(entry.getValue(), StandardCharsets.UTF_8));
}

// Create connection

URL url = new URL(urlBuilder.toString());
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

// Get response

int responseCode = conn.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(conn.getInputStream())
);

String inputLine;
StringBuilder response = new StringBuilder();
while ((inputLine = in .readLine()) != null) {
    response.append(inputLine);
} in .close();

// Check application-level status

System.out.println("HTTP Status Code: " + responseCode);
System.out.println("Response: " + response.toString());

// Disconnect

conn.disconnect();

Parámetros opcionales

En la siguiente tabla se enumeran los parámetros opcionales que admite este endpoint. Todos los parámetros enumerados son parámetros de consulta.

Parámetros opcionales
Parámetros de marca de tiempo
Parámetro	Descripción
`utime`	`int` El parámetro utime especifica la hora de la sesión en tiempo UNIX de 10 dígitos. Valor de ejemplo: `1483228800`
Parámetro	Descripción
`umilisec`	`int` El parámetro umilisec especifica el Tiempo de la sesión en milisegundos 13 dígitos de tiempo UNIX. Valor de ejemplo: `1483228800000`
Parámetros de dispositivo y red
Parámetro	Descripción
`global_properties`	`JSON URL-encoded string` El parámetro global_properties acepta un objeto JSON codificado en URL que contiene hasta 5 pares clave-valor. Cada clave y valor puede tener una longitud máxima de 200 caracteres. `{"key1":"value1","key2":"value2"}` El objeto JSON debe ser Convertido a una cadena JSON y codificado con URL. Valor de ejemplo: `%7B%22key1%22%3A%22value1%22%2C%22key2%22%3A%22value2%22%7D`
Parámetro	Descripción
`use_ip`	`string` El parámetro use_ip indica a Singular que extraiga la dirección IP de la solicitud HTTP en lugar del parámetro 'ip'. Pase'true' para utilizar esta función. El uso de este parámetro impide que Singular geolocalice el dispositivo basándose en la dirección IP. Puede proporcionar el código de país de dos letras del usuario en el parámetro opcional 'country'. Este parámetro es mutuamente excluyente con el parámetro 'ip'. NO lo utilice con el parámetro "ip". Para evitar que se rechacen los datos, debe proporcionar el parámetro "ip" o el parámetro "use_ip" en la solicitud. Valor de ejemplo: `true`
Parámetro	Descripción
`country`	`string` El parámetro country debe contener el código de país de dos letras ISO 3166-1 alpha-2 del usuario en el momento de la ejecución de la sesión. Este parámetro sólo es necesario cuando: El parámetro "ip" no está disponible Si el parámetro 'ip' está disponible, el país se determinará automáticamente a partir de la dirección IP, y el parámetro 'country' no es necesario. Ejemplo Valor: `US`
Parámetro	Descripción
`ua`	`URL-encoded string` El parámetro ua especifica el Agente de Usuario del dispositivo. `Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148` El valor debe estar codificado como URL. Valor de ejemplo: `Mozilla%2F5.0%20(iPhone%3B%20CPU%20iPhone%20OS%2014_0%20like%20Mac%20OS%20X)%20AppleWebKit%2F605.1.15%20(KHTML%2C%20like%20Gecko)%20Mobile%2F15E148`
Parámetro	Descripción
`c` Plataformas soportadas: iOS Android	`string` El parámetro c especifica el tipo de conexión de red'wifi' o'carrier'. Valor de ejemplo: `wifi`
Parámetro	Descripción
`cn` Plataformas soportadas: iOS Android	`string` El parámetro cn especifica el nombre de operador del proveedor de Internet. Valor de ejemplo: `Comcast`
Desinstalar soporte de seguimiento
Parámetro	Descripción
`apns_token` Plataformas soportadas: iOS	`string` El parámetro apns_token especifica el token de dispositivo del servicio de notificaciones push de Apple (APNS). Necesario para el seguimiento de desinstalación de iOS Asegúrese de pasar el token APNS como una cadena codificada en hexadecimal. Cómo recuperar el token APNS Valor de ejemplo: `b0adf7c9730763f88e1a048e28c68a9f806ed032fb522debff5bfba010a9b052`
Parámetro	Descripción
`fcm` Plataformas soportadas: Android	`string` El parámetro fcm especifica el token de dispositivo de Firebase Cloud Messaging. Se requiere para el seguimiento de desinstalación de Android Cómo recuperar el token FCM A continuación, pase el token de dispositivo en el parámetro fcm cuando informe de la sesión a Singular, como en el siguiente ejemplo: Ejemplo Valor: `bk3RNwTe3H0CI2k_HHwgIpoDKCIZvvD...MExUdFQ3P1`
Privacidad de datos
Parámetro	Descripción
`data_sharing_options`	`JSON URL-encoded string` El parámetro data_sharing_options especifica el consentimiento del usuario final para compartir información. Si se establece, este valor debe persistir y pasarse en cada solicitud posterior de "SESSION" y "EVENT" para el usuario. Para indicar que el usuario ha dado su consentimiento (opted-in) para compartir su información pase 'false': `{"limit_data_sharing":false}` Si el usuario se negó, introduzca "true": `{"limit_data_sharing":true}` El valor debe ser una cadena JSON codificada en URL. Valor de ejemplo: `%7B%22limit_data_sharing%22%3Atrue%7D`
Parámetro	Descripción
`dnt` Plataformas soportadas: Android iOS	`int` El parámetro dnt especifica el estado de Do Not Track. Pasa 1 si Do Not Track está activado o 0 si Do Not Track está desactivado. Valor de ejemplo: `0`
Parámetro	Descripción
`dntoff` Plataformas soportadas: iOS Android	`int` El parámetro dntoff especifica si "Do Not Track" está desactivado. Pase 0 si "do not track" está activado o 1 si "do not track" está desactivado. Valor de ejemplo: `1`
Soporte de Dispositivos Cruzados
Parámetro	Descripción
`custom_user_id`	`string` El parámetro custom_user_id especifica su ID de usuario interno. Valor de ejemplo: `123456789abcd`
Soporte SkAdNetwork iOS
Parámetro	Descripción
`skan_conversion_value` Plataformas soportadas: iOS	`int` El parámetro skan_conversion_value especifica el último valor de conversión de SKAdNetwork en el momento de esta notificación de sesión(más información sobre la implementación de SKAdNetwork). Valor de ejemplo: `7`
Parámetro	Descripción
`skan_first_call_timestamp` Plataformas soportadas: iOS	`int` El parámetro skan_first_call_timestamp especifica la marca de tiempo Unix de la primera llamada a la API SkAdNetwork subyacente(más información sobre la implementación de SKAdNetwork). Valor de ejemplo: `1483228800`
Parámetro	Descripción
`skan_last_call_timestamp` Plataformas soportadas: iOS	`int` El parámetro skan_last_call_timestamp especifica la marca de tiempo Unix de la última llamada a la API SkAdNetwork subyacente en el momento de esta notificación de sesión(más información sobre la implementación de SKAdNetwork). Valor de ejemplo: `1483228800`

Prueba de sesión

Tras la integración de servidor a servidor, es esencial verificar que Singular recibe datos antes de poner en marcha una instancia de producto. Consulte nuestra guía de pruebas para obtener más detalles. A grandes rasgos, deben seguirse los siguientes pasos:

Obtenga el ID de publicidad de su dispositivo de prueba y añádalo a la consola de Singular SDK.
Abra la consola de Singular SDK y añada el identificador del dispositivo para empezar a capturar datos.
Anule el identificador de la App con un identificador de App de desarrollo(com.singular.app.dev) para mantener los datos y eventos de prueba separados de los datos de producción.
Cree o abra la aplicación desde un estado finalizado
Compruebe que la apertura de la aplicación se envía al servidor con todos los puntos de datos de Singular necesarios.
Compruebe que el servidor envía la notificación de sesión al punto final"launch" de Singular con todos los datos necesarios.
Después de unos segundos, el evento de sesión debe aparecer en la consola de Singular SDK.
Repita la prueba, para validar que la App Open desencadena la Sesión desde cada entrada de App u operación "Foreground".

Verificaciones importantes

Confirme que el Evento de Sesión se produce al Abrir la App o al "Foreground" y antes de que se reciba el Evento.

Si ve la Sesión en la Consola SDK, ¡ha completado una prueba de extremo a extremo del manejo de la SESIÓN!