徽章
徽章是一种奖励，可以添加到用户在帮助中心的个人资料中。有关更多信息，请参见关于收集徽章在Ze亚博ndesk帮助。
徽章可在收集专业计划。
JSON格式
徽章有以下属性:
| 的名字 | 类型 | 只读 | 强制性的 | 评论 |
|---|---|---|---|---|
| id | 字符串 | 是的 | 没有 | 在创建徽章时自动分配 |
| badge_category_id | 字符串 | 是的 | 是的 | 徽章类别id |
| 的名字 | 字符串 | 没有 | 是的 | 徽章的名称 |
| 描述 | 字符串 | 没有 | 是的 | 徽章的描述。可能是空字符串 |
| icon_url | 字符串 | 没有 | 没有 | 徽章图标的URL |
| created_at | 时间戳 | 是的 | 没有 | 当创建徽章时 |
| updated_at | 时间戳 | 是的 | 没有 | 上一次更新徽章的时间 |
例子
｛“id”：“01 e86xpprdcnhytsvwsrmd76r0”，“badge_category_id”：“01 e86xpm9459s78f83vh8cd69h”，“名称”：“社区英雄”，“描述”：“拯救社区!”，“icon_url”：“https://..”。，“created_at”：“2020 - 05 - 13 - t11:46:19.000z”，“updated_at”：“2020 - 05 - 13 - t11:46:19.000z”｝
列表徽章
GET / api / v2 /收集/徽章
列出所有徽章。
属性可以进一步筛选此请求brand_id查询字符串参数仅显示特定品牌内的徽章类别。
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| brand_id | 整数 | 查询 | 假 | 返回指定品牌的徽章 |
允许
- 帮助中心经理
使用旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/gather/badges＼- v - u｛email_address｝：｛密码｝
示例响应
状态:200 OK｛“徽章”:(｛“id”:“01 e86xpprdcnhytsvwsrmd76r0”,“badge_category_id”:“01 e86xpm9459s78f83vh8cd69h”,“名字”:“社区超级英雄”，"description": "拯救社区!"，“icon_url”:“https://..”。“created_at”:“2020 - 05 - 13 t11:46:19.000z”,“updated_at”:“2020 - 05 - 13 - t11:46:19.000z”}，｛“id”:“01 e89dz2na6zpmbmrpfrxc2bry”,“badge_category_id”:“01 e86xpm9459s78f83vh8cd69h”,"name": "Smart Cookie"，"描述":"对难题的巧妙回答。"“icon_url”:空,“created_at”:“2020 - 05 - 14 t11:08:59.000z”,“updated_at”:“2020 - 05 - 14 - t11:08:59.000z”｝］｝
显示徽章
GET / api / v2 /收集/徽章/ {id}
显示单个徽章的信息。
允许
- 帮助中心经理
使用旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/gather/badges/｛id｝＼- v - u｛email_address｝：｛密码｝
示例响应
状态:200 OK｛“徽章”:{“id”:“01 e86xpprdcnhytsvwsrmd76r0”,“badge_category_id”:“01 e86xpm9459s78f83vh8cd69h”,“名字”:“社区超级英雄”，描述:“你在社区里拯救了一天!”，“icon_url”:“https://..”。“created_at”:“2020 - 05 - 13 t11:46:19.000z”,“updated_at”:“2020 - 05 - 13 - t11:46:19.000z”｝｝
创建徽章
POST / api / v2 /收集/徽章
若要创建没有图标的徽章，请省略icon_upload_id，或设置为null。
创建带有图标的徽章:
- 请求徽章图标上传URL．
- 上传图标到所提供的URL的附加头。
- 发送
POST / api / v2 /收集/徽章请求，同时设置icon_upload_id的价值badge_icon_upload.id从第一步的响应。
基于base64的上传机制涉及icon_url已弃用。
允许
- 帮助中心经理
使用旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/gather/badges＼- d'{"badge": {" badge_category_id": "…"，"name": "社区超级英雄"，"description": "在社区拯救一天!"，"icon_upload_id": "01EYV0KR9EA8VGFMFDMEKPT15C"}}'＼- v - u｛email_address｝：｛密码｝-x post -h“application / json内容类型:
请求徽章图标上传URL
POST / api / v2 /收集/徽章/ icon_uploads
返回一个badge_icon_upload对象，由以下属性组成:
| 的名字 | 类型 | 描述 |
|---|---|---|
| id | 字符串 | 标识徽章图标上传的字符串。稍后在创建或更新徽章时使用 |
| url | 字符串 | 预签名的AWS S3 URL，徽章图标将在单独的请求中上传。URL在创建一小时后过期 |
| 头 | 对象 | 一个对象，其中包含已签名的头键-值对，在上传徽章图标时必须包含在对预签名的S3 URL的请求中 |
请求体接受一个具有以下属性的对象:
| 的名字 | 类型 | 描述 |
|---|---|---|
| content_type | 字符串 | 要上传的徽章图标的内容类型。允许的类型:“image/svg+xml”，“image/png”，“image/jpeg”，或“image/gif” |
| file_size | 整数 | 徽章图标大小(以字节为单位) |
允许
- 帮助中心经理
使用旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/gather/badges/icon_uploads＼- v - u｛email_address｝：｛密码｝- d”{content_type”:“图像/ svg + xml”、“file_size”:420000}”＼-x post -h“application / json内容类型:
示例响应
状态:201已创建｛" badge_icon_upload ": {“id”:“01 eyv0kr9ea8vgfmfdmekpt15c”,“url”:“https://aus -上传资产- production.s3.amazonaws.com/26/1749971/01eyv0kr9ea8vgfmfdmekpt15c?content type=image%2fsvg%2bxml&x湄京- algorithm=aws4 hmac - sha256&x湄京,credential=akiayspzoxopsgbvqtma%2f20210218%2fus -东- 1% - 2 - fs3%2faws4_request&x湄京date=20210218t164716z&x湄京- expires=3600&x湄京- signature=0d297b81820ffe8b609e0f801e73eb5a62b6a6108cd076d26a378a3a22e5efde&x湄京signedheaders=content - disposition%3bhost%3bx湄京-服务器-方- encryption&x湄京-服务器- - encryption=aes256”,"标题":{“附加”:“依恋;文件名= \“01 eyv0kr9ea8vgfmfdmekpt15c.svg \”,“内容类型”:“图像/ svg + xml”,:“X-Amz-Server-Side-Encryption AES256”｝｝｝
上传徽章图标
把{path_to_icon}
方法返回的URL指定的位置请求徽章图标上传URL端点。的URL中指定url的属性badge_icon_upload对象。中的头文件头的属性badge_icon_upload对象发送到PUT请求。
使用旋度
旋度-X PUT -T /path/to/your/image.svg＼- h“内容类型:图像/ svg + xml”＼- h“附加项:附件;文件名=\”01 eyv0kr9ea8vgfmfdmekpt15c.svg\”＂＼- h“X-Amz-Server-Side-Encryption: AES256”＼- l“https://aus -上传资产- production.s3.amazonaws.com/26/1749971/01eyv0kr9ea8vgfmfdmekpt15c?content type=image%2fsvg%2bxml&x湄京- algorithm=aws4 hmac - sha256&x湄京,credential=akiayspzoxopsgbvqtma%2f20210218%2fus -东- 1% - 2 - fs3%2faws4_request&x湄京date=20210218t164716z&x湄京- expires=3600&x湄京- signature=0d297b81820ffe8b609e0f801e73eb5a62b6a6108cd076d26a378a3a22e5efde&x湄京signedheaders=content - disposition%3bhost%3bx湄京-服务器-方- encryption&x湄京-服务器- - encryption=aes256”
更新的徽章
把/ api / v2 /收集/徽章/ {id}
若要更新徽章以使其没有图标，请设置icon_upload_id为null。
若要保持现有图标不变，请省略icon_upload_id．
使用新图标更新徽章:
- 请求徽章图标上传URL．
- 上传图标到所提供的URL的附加头。
- 发送
把/ api / v2 /收集/徽章/ {id}请求，同时设置icon_upload_id的价值badge_icon_upload.id从第一步的响应。
基于base64的上传机制涉及icon_url已弃用。
允许
- 帮助中心经理
使用旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/gather/badges/｛id｝＼- v - u｛email_address｝：｛密码｝- d“{"badge": {" badge_category_id": "…"，"name": "社区超级英雄"，"description": "拯救社区!"}}’＼-x乘以-h“application / json内容类型:
删除标记
删除/ api / v2 /收集/徽章/ {id}
删除徽章也会删除属于该徽章的所有徽章分配。
允许
- 帮助中心经理
使用旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/gather/badges/｛id｝＼- v - u｛email_address｝：｛密码｝- x删除
示例响应
状态:204无内容