测试控制台API参考[beta]

关注
Avatar
Dora Kishinevsky
Updated

测试控制台 API 是Singular 应用程序中测试控制台页面的替代工具。这两种工具都可以让你测试你的Singular SDK或S2S集成，向你展示从你的设备（你安装应用程序的注册测试设备）发送到Singular服务器的数据。

如果您的应用程序正确集成了 Singular SDK/S2S，设备就会向 Singular 发送用户会话和事件，并包含您实现的所有属性。

更多信息，请参阅：

快速入门指南

1 调用注册设备端点（Register Device Endpoint）注册测试设备。
2 等待 5 秒钟，然后调用 "检查设备注册"，查看设备是否已注册并准备记录。
3

设备准备就绪后，使用设备执行要测试的应用程序事件。 有关如何测试 SDK/S2S 集成的不同功能的详细信息，请参阅如何测试 Singular SDK 集成。

注意：
  • 日志最多会显示 100 个事件。如果要测试的事件超过 100 个，则需要多次检索日志。
  • 设备注册会在一小时后过期。如果您需要更多时间来执行事件，请再次调用注册设备（请参阅API 约束和限制）。
4 调用 "检索日志"（Retrieve Logs）端点，查看设备发送给 Singular 的内容。
5 可选择调用 "取消注册设备"（Unregister Device）。 如果不这样做，在调用 "注册设备"（Register Device）一小时后，设备注册将自动失效。

API 端点参考

注册设备端点

POST api.singular.net/api/event_logger/device

使用方法

使用此端点注册设备以启动新的记录会话。 记录会话将在 1 小时后自动过期。

调用示例

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

查询参数

参数 是否需要？ 说明
api_key 必填（如果未在授权头中传递） 要获取 Singular API 密钥，请登录 Singular 账户，进入 "设置">"API"。单击 "显示密钥"，然后复制密钥。
device_id 需要 您要注册的测试设备的 ID，例如：058000d94-1972-448b-8c08-32c0ccc81fa4
keyspace 必填 给出的设备 ID 类型，如 AIFA
platform 必须填写 设备平台，如 Android

预期响应

注意：即使响应显示注册成功（状态 200），控制台仍可能无法记录事件。我们建议等待 1 秒钟，然后调用 "检查设备注册 "端点。

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

检查设备注册端点

GET api.singular.net/api/event_logger/device

使用方法

使用此端点可检查给定设备是否已在测试控制台中注册。 如果设备已注册，且记录仪已准备好开始从设备收集信息，则可开始在设备上执行应用程序事件以进行测试。

查询参数

参数 是否需要？ 说明
api_key 必填（如果未在授权标头中传递） 要获取 Singular API 密钥，请登录 Singular 账户，进入 "设置">"API"。单击 "显示密钥"，然后复制密钥。
device_id 必填 您注册的设备 ID，例如：058000d94-1972-448b-8c08-32c0ccc81fa4
keyspace 必填 给出的设备 ID 类型，如 AIFA
platform 必须填写 设备平台，例如 Android

可能的回复

响应 含义 
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”
  }
 设备未注册或注册超时。 再次调用注册设备端点。

检索日志端点

GET api.singular.net/api/event_logger/retrieve_logs

使用方法

使用此端点可检索当前会话中设备的所有 Singular 记录事件。

查询参数

参数 是否需要？ 说明
api_key 必填（如果未在授权头中传递） 要获取 Singular API 密钥，请登录 Singular 账户，进入 "设置">"API"。点击显示密钥，然后复制密钥。
device_id 需要 您正在测试的设备的 ID，例如：058000d94-1972-448b-8c08-32c0ccc81fa4
keyspace 必填 给出的设备 ID 类型，如 AIFA
platform 必须填写 设备平台，如 Android

查询响应

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

取消注册设备端点

DELETE api.singular.net/api/event_logger/event_logger/device

使用方法

使用此端点停止已注册设备的记录会话。

查询参数

参数 是否需要？ 说明
api_key 必填（如果未在授权头中传递） 要获取 Singular API 密钥，请登录 Singular 账户，进入 "设置">"API"。点击显示密钥，然后复制密钥。
device_id 必填 您注册的设备 ID，例如：058000d94-1972-448b-8c08-32c0ccc81fa4
device_id_type 必填 给出的设备 ID 类型，如 AIFA
platform 必须填写 设备平台，例如 Android

 

可能的响应

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

API 约束和限制

API 对每个客户端（api-key）都有以下限制：

  1. 每个记录会话将在 1 小时后过期，过期后，记录会话事件的所有数据将被删除，新数据将无法跟踪。 您可以在已注册的设备上再次发送注册设备请求，将会话过期时间延迟一小时。
  2. 每个 api-key 一次只能打开 50 个记录会话（针对 50 台设备）。在成功注册设备和取消注册设备请求时，将发送 open_sessions_num 以帮助您监控打开会话的数量。
  3. 每个设备记录事件的最大数量为 100。达到上限后，旧事件将从日志中删除，以便为新事件腾出空间。
  4. API 每秒最多可接收 20 个请求。