La API de la consola de pruebas es una alternativa a la página de la consola de pruebas de la aplicación Singular. Ambas herramientas te permiten probar tu integración con Singular SDK o S2S mostrándote qué datos se envían desde tu dispositivo (un dispositivo de prueba registrado en el que instalas tu app) a los servidores de Singular.

Si Singular SDK/S2S está correctamente integrado en su aplicación, el dispositivo debería enviar sesiones de usuario y eventos a Singular con todas las propiedades que usted haya implementado.

Para más información, consulte:

• Cómo probar su integración con Singular SDK
• Herramienta de auditoría para integraciones SDK/S2S
• Preguntas frecuentes sobre la consola de pruebas y resolución de problemas

Guía de inicio rápido

Referencia de puntos finales de la API

Punto final de registro de dispositivos

Uso

Utilice este punto final para registrar un dispositivo con el fin de iniciar una nueva sesión de registro. La sesión de registro caducará automáticamente transcurrida una hora.

Ejemplo de llamada

POST 'https://api.singular.net/api/event_logger/device?api_key=<api-key>'
  
  Request body:
  {
      "device_id": "058000d94-1972-448b-8c08-32c0ccc81fa4",
      "keyspace": "AIFA",
      "platform": "Android"
  }

Parámetros de consulta

Respuesta esperada

{
      "status": 0, 
      "log_session_info":
          {
              "session_expire_timestamp": 1647448055, 
              "session_start_timestamp": 1647444455,
              "session_id": "eceece6f-ef54-4f1a-8fe9-d3da1563c05a"
          },
      "registered_devices_num": 2
  }

Comprobar registro de dispositivo

Uso

Utilice este endpoint para comprobar si un dispositivo dado está registrado en la consola de Pruebas. Si el dispositivo está registrado, y el registrador está listo para empezar a recoger información del dispositivo, puede empezar a ejecutar eventos en la aplicación en el dispositivo para probarlos.

Parámetros de consulta

Posibles respuestas

HTTP 200
  
  {
      “status”:0,
      “message”: “Device registered”,
      “log_session_info”: [session_id, session_start_timestamp, session_expire_timestamp]
  }

HTTP 307
              
  Header: Retry After <delay seconds>
          
  {
      “status”:1,
      “session_id”,
      “message”:”Device registration
        in progress, retry after 
         x seconds”
  }

HTTP 404
              
  {
      “status”:”3”,
      "message”:”Device not registered”
  }

Punto final de recuperación de registros

Uso

Utilice este punto final para recuperar todos los eventos registrados de Singular para el dispositivo, para la sesión actual.

Parámetros de consulta

Respuesta a la consulta

Success: HTTP 200 
  
  {
      “status”:0,
      “Message”:”Request OK”
      “log_session_info”: [session_id, session_start_timestamp, session_expire_timestamp]
      “event_details”: [payload]
  }

Anular el registro de un dispositivo

Uso

Utilice este punto final para detener una sesión de registro de un dispositivo registrado.

Parámetros de la consulta

Posibles respuestas

Success: HTTP 200
  
  {
      “status”:0,
      “message”:”Device unregistered”
      “open_sessions_num”,
      “log_session_info”: [session_id, session_start_timestamp, session_expire_timestamp]
  }

Error: HTTP 400
  
  {
      “status”:”1”, 
      “message”:”Invalid request, check required fields”
  }

HTTP 204
  
  {
      “status”:”2”, 
      “message”:”Device not registered”
  }

Restricciones y limitaciones de la API

La API tendrá la siguiente limitación para cada cliente (api-key):

1. Cada sesión de registro caduca al cabo de 1 hora, después de lo cual se borrarán todos los datos de los eventos de la sesión de registro y no se rastrearán nuevos datos. Puede enviar otra solicitud Register Device (Registrar dispositivo) en un dispositivo ya registrado para retrasar una hora la caducidad de la sesión.
2. Sólo puede haber 50 sesiones de registro abiertas (para 50 dispositivos) a la vez, por api-key. En las solicitudes de registro y anulación de registro de dispositivos, se enviará un open_sessions_num para ayudarle a controlar el número de sesiones abiertas.
3. El número máximo de eventos registrados por dispositivo es de 100. Una vez alcanzado el límite, los eventos más antiguos se eliminarán del registro para dejar espacio a los nuevos.
4. La API puede recibir hasta 20 peticiones por segundo.