A API do console de teste é uma alternativa à página do console de teste no aplicativo Singular. Ambas as ferramentas permitem testar a integração do Singular SDK ou S2S, mostrando quais dados são enviados do seu dispositivo (um dispositivo de teste registrado no qual você instala seu aplicativo) para os servidores Singular.

Se o Singular SDK/S2S estiver integrado corretamente ao seu aplicativo, o dispositivo deverá enviar sessões de usuário e eventos para o Singular com todas as propriedades que você implementou.

Para obter mais informações, consulte:

• Como testar sua integração com o Singular SDK
• Ferramenta de auditoria para integrações SDK/S2S
• Perguntas frequentes sobre o console de teste e solução de problemas

Guia de início rápido

Referência do endpoint da API

Ponto de extremidade Registrar dispositivo

Uso

Use esse ponto de extremidade para registrar um dispositivo a fim de iniciar uma nova sessão de registro. A sessão de registro expirará automaticamente após 1 hora.

Exemplo de chamada

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

Resposta 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
  }

Ponto de extremidade Check Device Registration (Verificar registro do dispositivo)

Uso

Use esse ponto final para verificar se um determinado dispositivo está registrado no console de teste. Se o dispositivo estiver registrado e o registrador estiver pronto para começar a coletar informações do dispositivo, você poderá começar a executar eventos no aplicativo do dispositivo para testá-los.

Parâmetros de consulta

Respostas possíveis

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”
  }

Ponto de extremidade Retrieve Logs (Recuperar registros)

Uso

Use esse ponto de extremidade para recuperar todos os eventos registrados da Singular para o dispositivo, para a sessão atual.

Parâmetros de consulta

Resposta da consulta

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

Ponto de extremidade do dispositivo sem registro

Uso

Use esse ponto de extremidade para interromper uma sessão de registro para um dispositivo registrado.

Parâmetros da consulta

Respostas possíveis

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”
  }

Restrições e limitações da API

A API terá a seguinte limitação para cada cliente (api-key):

1. Cada sessão de registro expira após 1 hora; depois disso, todos os dados sobre os eventos da sessão de registro serão excluídos e novos dados não serão rastreados. Você pode enviar outra solicitação Register Device em um dispositivo já registrado para adiar a expiração da sessão em uma hora.
2. Só pode haver 50 sessões de registro abertas (para 50 dispositivos) de cada vez, por chave API. Em solicitações bem-sucedidas de Register Device e Unregister Device, um open_sessions_num será enviado para ajudá-lo a monitorar o número de sessões abertas.
3. O número máximo de eventos registrados por dispositivo é 100. Depois que o limite for atingido, os eventos mais antigos serão removidos do registro para abrir espaço para os novos.
4. A API pode receber até 20 solicitações por segundo.