API推送通知用于细分群体
注意
该门户网站正在开发中。文档的完整版本请看这里.
概述
要处理细分群体，需要以下工件：
- project_idproject_id (项目ID), ss_token (服务令牌)。这些值可以在开发者控制台获得。为此，需要进入应用页面的「推送通 知」>「项目」部分。发送推送通知
- push_token.用于订阅和取消订阅主题分发的设备的推送令牌。
- mt_api_user_id。 来自myTracker的API User ID。
- mt_secret_key。 来自myTracker的API的秘密密钥。
- mt_segment_id.来自myTracker的细分群体标识符。
- mt_app_id.应用程序标识符。
- export_project_idexport_project_id (uuid)。带有导出设置的项目标识符。
- export_segment_idexport_segment_id (uuid)。用于导出的细分群体标识符。
创建带有导出设置的项目
POSThttps://vkpns-segments.rustore.ru/v1/export_settings/project/create
需要标题Authorization：Authorization：Bearer $ss_tokenss_token
请求正文
| 参数 | 类型 | 描述 |
|---|---|---|
project | text | project_id |
api_user_id | text | mt_api_user_id |
secret_key | text | mt_secret_key |
app_id | int | mt_app_id |
成功响应的正文
| 参数 | 类型 | 描述 |
|---|---|---|
export_project_id | text | export_project_id |
错误响应的正文
| 参数 | 类型 | 描述 |
|---|---|---|
code | int | 错误代码 |
status | text | 状态 |
message | text | 详细错误 |
获取项目的导出设置
POSThttps://vkpns-segments.rustore.ru/v1/export_settings/project/get
需要标题Authorization：Authorization：Bearer $ss_tokenss_token
请求正文
| 参数 | 类型 | 描述 |
|---|---|---|
id | text | export_project_id |
成功响应的正文
| 参数 | 类型 | 描述 |
|---|---|---|
id | text | export_project_id |
project | text | project_id |
app_id | int | mt_app_id |
错误响应的正文
| 参数 | 类型 | 描述 |
|---|---|---|
code | int | 错误代码 |
status | text | 状态 |
message | text | 详细错误 |
为导出创建细分群体
POSThttps://segments-vkpns.rustore.ru/v1/export_settings/project//segments/create
需要标题Authorization：Authorization：Bearer $ss_tokenss_token
请求正文
| 参数 | 类型 | 描述 |
|---|---|---|
period | int | 按小时的数据导出频率 |
segment | text | mt_segment_id |
成功响应的正文
| 参数 | 类型 | 描述 |
|---|---|---|
export_segment_id | text | export_segment_id |
错误响应的正文
| 参数 | 类型 | 描述 |
|---|---|---|
code | int | 错误代码 |
status | text | 状态 |
message | text | 详细错误 |
获取用于导出的细分群体数据
POSThttps://segments-vkpns.rustore.ru/v1/export_settings/project//segments/get
需要标题Authorization：Authorization：Bearer $ss_tokenss_token
成功响应的正文
| 参数 | 类型 | 描述 |
|---|---|---|
segments | array | 带有细分群体的数组 |
Segment
| 参数 | 类型 | 描述 |
|---|---|---|
id | text | export_segment_id |
segment | text | mt_segment_id |
period | int | 按小时的数据导出频率 |
is_enabled | boolean | 标志，表示是否启用了这个细分群体 |
错误响应的正文
| 参数 | 类型 | 描述 |
|---|---|---|
code | int | 错误代码 |
status | text | 状态 |
message | text | 详细错误 |
将推送通知发送到细分群体
POST https://segments-vkpns.rustore.ru/v1/projects//segments//publish
需要标题Authorization：Authorization：Bearer $ss_tokenss_token
请求正文
| 参数 | 类型 | 描述 |
|---|---|---|
message | object(message) | 消息 |
成功响应的正文
| 参数 | 类型 | 描述 |
|---|---|---|
message | text | 推送成功发送的消息 |
错误响应的正文
| 参数 | 类型 | 描述 |
|---|---|---|
code | int | 错误代码 |
status | text | 状态 |
message | text | 详细错误 |
示例
创建带有导出设置的项目
curl \--location \'https://vkpns-segments.rustore.ru/v1/export_settings/project/create\' \\\--header \'Content-Type: application/json\' \\\--header \'Accept: application/json\' \\\--header \'Authorization: Bearer \<ss_token\>\' \\\--data \'{ \`\`\"project\" : \"\<project_id\>\" , \`\`\"api_user_id\" : \"\<mt_api_user_id\>\" , \`\`\"secret_key\" : \"\<mt_secret_key\>\" , \`\`\"app_id\" : \<mt_app_id\>}\'
成功的响应
HTTP/ 2 200{ \`\`\"project_id\" : \"b04b48ab-3125-444f-94eb-aad511c074e7\"}
无效的s2s-令牌
HTTP/ 2 400{ \`\`\"code\" : 2000 , \`\`\"status\" : \"BAD_REQUEST\" , \`\`\"message\" : \"Invalid S2S token\"}
获取项目的导出设置
curl \--location \'https://segments-vkpns.rustore.ru/v1/export_settings/project/get\' \\\--header \'Content-Type: application/json\' \\\--header \'Accept: application/json\' \\\--header \'Authorization: Bearer \<ss_token\>\' \\\--data \'{ \`\`\"id\" : \"\<export_project_id\>\"}\'
成功的响应
HTTP/ 2 200{ \`\`\"id\" : \"\<export_project_id\>\" , \`\`\"app_id\" : \<mt_app_id\>, \`\`\"project\" : \"\<project_id\>\"}
为导出创建细分群体
curl \--location \'https://segments-vkpns.rustore.ru/v1/export_settings/project/\<export_project_id\>/segments/create\' \\\--header \'Content-Type: application/json\' \\\--header \'Accept: application/json\' \\\--header \'Authorization: Bearer \<ss_token\>\' \\\--data \'{ \`\`\"period\" : 24, \`\`\"segment\" : \"\<mt_segment_id\>\"}\'
成功的响应
HTTP/ 2 200{ \`\`\"segment_id\" : \"\<export_segment_id\>\"}
获取用于导出的细分群体数据
curl \--location \--request POST \'https://segments-vkpns.rustore.ru/v1/export_settings/project/\<export_project_id\>/segments/get\' \\\--header \'Accept: application/json\' \\\--header \'Authorization: Bearer \<ss_token\>\'
成功的响应
HTTP/ 2 200{ \`\`\"segments\" : \[ \`\`{ \`\`\"id\" : \"\<export_segment_id\>\" , \`\`\"segment\" : \"\<mt_segment_id\>\" , \`\`\"period\" : 24 , \`\`\"is_enabled\" : true \`\`} \`\`\]}
向细分群体发送消息
curl \--location \'https://segments-vkpns.rustore.ru/v1/projects/\<project_id\>/segments/\<mt_segment_id\>/publish\' \\\--header \'Content-Type: application/json\' \\\--header \'Accept: application/json\' \\ \`\`\--header \'Authorization: Bearer \<ss_token\>\' \\\--data \'{ \`\`\"message\" : { \`\`\"notification\" :{ \`\`\"body\" : \"This is a notification message!\" , \`\`\"title\" : \"Message\" , \`\`\"image\" : \"https://image-hosting.org/284239234.jpeg\" \`\`} \`\`}}\'
成功的响应
HTTP/ 2 200{ \`\`\"message\" : \"payload has been successfully published to segment \<mt_segment_id\>\"}