品牌
品牌是你面向客户的身份。它们可能代表多种产品或服务，或者它们可能是您的公司拥有和代表的多个品牌。
如果票据是由非品牌渠道生成的，则默认品牌是分配给票据的品牌。属性可以更新默认品牌更新帐户设置端点。
JSON格式
品牌被表示为具有以下属性的JSON对象:
| 的名字 | 类型 | 只读 | 强制性的 | 描述 |
|---|---|---|---|---|
| 活跃的 | 布尔 | 假 | 假 | 如果将品牌设置为活动 |
| brand_url | 字符串 | 假 | 假 | 品牌的url |
| created_at | 字符串 | 真正的 | 假 | 品牌创建的时间 |
| 默认的 | 布尔 | 假 | 假 | 该品牌是此帐户的默认品牌吗 |
| has_help_center | 布尔 | 假 | 假 | 如果该品牌有帮助中心 |
| help_center_state | 字符串 | 真正的 | 假 | 帮助中心的状态。允许的值包括enabled, disabled, restricted。 |
| host_mapping | 字符串 | 假 | 假 | 到该品牌的主机映射(如果有的话)。只有管理员才能查看此属性。 |
| id | 整数 | 真正的 | 假 | 创建品牌时自动分配的ID |
| is_deleted | 布尔 | 假 | 假 | 是否删除品牌对象 |
| 标志 | 对象 | 假 | 假 | 表示为的文件附件对象 |
| 的名字 | 字符串 | 假 | 真正的 | 品牌名称 |
| signature_template | 字符串 | 假 | 假 | 品牌的签名模板 |
| 子域名 | 字符串 | 假 | 真正的 | 品牌的子域 |
| ticket_form_ids | 数组 | 真正的 | 假 | 可供品牌使用的票证的id |
| updated_at | 字符串 | 真正的 | 假 | 品牌最后一次更新的时间 |
| url | 字符串 | 真正的 | 假 | 该品牌的API url |
例子
｛“活跃”：真正的,“brand_url”：“https://brand1.com”,“created_at”：“2012 - 04 - 02 - t22:55:29z”,“默认”：真正的,“has_help_center”：真正的,“help_center_state”：“启用”,“host_mapping”：“brand1.com”,“id”：47,“标志”：｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/logos/brand1_logo.png”,“file_name”：“brand1_logo.png”,“id”：928374,“大小”：166144,“缩略图”：［｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/photos/brand1_logo_thumb.png”,“file_name”：“brand1_logo_thumb.png”,“id”：928375,“mapped_content_url”：“https://company.com/photos/brand1_logo_thumb.png”,“大小”：58298,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928375.json”｝,｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/photos/brand1_logo_small.png”,“file_name”：“brand1_logo_small.png”,“id”：928376,“mapped_content_url”：“https://company.com/photos/brand1_logo_small.png”,“大小”：58298,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928376.json”｝］,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928374.json”｝,“名称”：“1”品牌,“signature_template”：“{{agent.signature}}”,“子域名”：“brand1”,“ticket_form_ids”：［47,33,22］,“updated_at”：“2012 - 04 - 02 - t22:55:29z”,“url”：“https://company.亚博zendesk.com/api/v2/brands/47.json”｝
品牌列表
GET / api / v2 /品牌
返回您帐户中按名称排序的所有品牌的列表。
允许
- 管理员、代理商
代码示例
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/brands.json＼- v - u｛email_address｝：｛密码｝
去
进口（“fmt”“输入输出”"net/http”）函数主要（）｛url: =“https://example.亚博zendesk.com/api/v2/brands”方法: =“获得”要求的事情,犯错: =http．NewRequest（方法,url,零）如果犯错! =零｛fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”,“application / json”）要求的事情．头．添加（“授权”,“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http．客户端｛｝res,犯错: =客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体,犯错: =io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Nodejs
varaxios＝需要（“axios”）；var配置＝｛方法：“得到”,url：“https://example.亚博zendesk.com/api/v2/brands”,头：｛“内容类型”：“application / json”,“授权”：的基本< auth-value >”,// Base64编码的"username:password"｝,｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python
进口请求url＝“https://example.亚博zendesk.com/api/v2/brands”头＝｛“内容类型”：“application / json”,｝响应＝请求．请求（“获得”,url,身份验证＝（“<用户名>”,' <密码> '）,头＝头）打印（响应．文本）
Ruby
需要"net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/brands”）请求＝网：：HTTP：：得到．新（uri,“内容类型”：“application / json”）请求．basic_auth“用户名”,“密码”响应＝网：：HTTP．开始uri．主机名,uri．港口,use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
// Status 200 OK｛“品牌”：［｛“活跃”：真正的,“brand_url”：“https://brand1.亚博zendesk.com”,“created_at”：“2019 - 08 - 06 - t02:43:39z”,“默认”：真正的,“has_help_center”：真正的,“help_center_state”：“启用”,“host_mapping”：“brand1.com”,“id”：360002783572,“is_deleted”：假,“标志”：｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/logos/brand1_logo.png”,“file_name”：“brand1_logo.png”,“id”：928374,“mapped_content_url”：“https://company.com/logos/brand1_logo.png”,“大小”：166144,“缩略图”：［｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/photos/brand1_logo_thumb.png”,“file_name”：“brand1_logo_thumb.png”,“id”：928375,“mapped_content_url”：“https://company.com/photos/brand1_logo_thumb.png”,“大小”：58298,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928375.json”｝,｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/photos/brand1_logo_small.png”,“file_name”：“brand1_logo_small.png”,“id”：928376,“mapped_content_url”：“https://company.com/photos/brand1_logo_small.png”,“大小”：58298,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928376.json”｝］,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928374.json”｝,“名称”：“1”品牌,“signature_template”：“{{agent.signature}}”,“子域名”：“hello world”,“ticket_form_ids”：［360000660811］,“updated_at”：“2019 - 08 - 06 - t02:43:40z”,“url”：“https://company.亚博zendesk.com/api/v2/brands/360002783572.json”｝］,“数”：1,“next_page”：零,“previous_page”：零｝
展示品牌
GET / api / v2 /品牌/ {brand_id}
为您的帐户返回一个品牌。
允许
- 管理员、代理商
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| brand_id | 整数 | 路径 | 真正的 | 品牌标识 |
代码示例
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/brands/｛brand_id｝. json＼- v - u｛email_address｝：｛密码｝
去
进口（“fmt”“输入输出”"net/http”）函数主要（）｛url: =“https://example.亚博zendesk.com/api/v2/brands/360002783572”方法: =“获得”要求的事情,犯错: =http．NewRequest（方法,url,零）如果犯错! =零｛fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”,“application / json”）要求的事情．头．添加（“授权”,“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http．客户端｛｝res,犯错: =客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体,犯错: =io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Nodejs
varaxios＝需要（“axios”）；var配置＝｛方法：“得到”,url：“https://example.亚博zendesk.com/api/v2/brands/360002783572”,头：｛“内容类型”：“application / json”,“授权”：的基本< auth-value >”,// Base64编码的"username:password"｝,｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python
进口请求url＝“https://example.亚博zendesk.com/api/v2/brands/360002783572”头＝｛“内容类型”：“application / json”,｝响应＝请求．请求（“获得”,url,身份验证＝（“<用户名>”,' <密码> '）,头＝头）打印（响应．文本）
Ruby
需要"net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/brands/360002783572”）请求＝网：：HTTP：：得到．新（uri,“内容类型”：“application / json”）请求．basic_auth“用户名”,“密码”响应＝网：：HTTP．开始uri．主机名,uri．港口,use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
// Status 200 OK｛“品牌”：｛“活跃”：真正的,“brand_url”：“https://brand1.亚博zendesk.com”,“created_at”：“2019 - 08 - 06 - t02:43:39z”,“默认”：真正的,“has_help_center”：真正的,“help_center_state”：“启用”,“host_mapping”：“brand1.com”,“id”：360002783572,“is_deleted”：假,“标志”：｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/logos/brand1_logo.png”,“file_name”：“brand1_logo.png”,“id”：928374,“mapped_content_url”：“https://company.com/logos/brand1_logo.png”,“大小”：166144,“缩略图”：［｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/photos/brand1_logo_thumb.png”,“file_name”：“brand1_logo_thumb.png”,“id”：928375,“mapped_content_url”：“https://company.com/photos/brand1_logo_thumb.png”,“大小”：58298,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928375.json”｝,｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/photos/brand1_logo_small.png”,“file_name”：“brand1_logo_small.png”,“id”：928376,“mapped_content_url”：“https://company.com/photos/brand1_logo_small.png”,“大小”：58298,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928376.json”｝］,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928374.json”｝,“名称”：“1”品牌,“signature_template”：“{{agent.signature}}”,“子域名”：“hello world”,“ticket_form_ids”：［360000660811］,“updated_at”：“2019 - 08 - 06 - t02:43:40z”,“url”：“https://company.亚博zendesk.com/api/v2/brands/360002783572.json”｝｝
创建品牌
POST / api / v2 /品牌
允许
- 管理员
例子的身体
｛“品牌”：｛“名称”：“1”品牌,“子域名”：“Brand1”｝｝
代码示例
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/brands.json＼- h“application / json内容类型:- x的帖子＼- d“{”牌”:{“名称”:“1”品牌,“子域名”:“brand1}}”＼- v - u｛email_address｝：｛密码｝
去
进口（“fmt”“输入输出”"net/http”“弦”）函数主要（）｛url: =“https://example.亚博zendesk.com/api/v2/brands”方法: =“职位”有效载荷: =字符串．NewReader（”{"品牌":{“name”:“Brand 1”，“子域名”:“Brand1”｝} '）要求的事情,犯错: =http．NewRequest（方法,url,有效载荷）如果犯错! =零｛fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”,“application / json”）要求的事情．头．添加（“授权”,“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http．客户端｛｝res,犯错: =客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体,犯错: =io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Nodejs
varaxios＝需要（“axios”）；var数据＝JSON．stringify（｛“品牌”：｛“名称”：“1”品牌,“子域名”：“Brand1”｝｝）；var配置＝｛方法：“职位”,url：“https://example.亚博zendesk.com/api/v2/brands”,头：｛“内容类型”：“application / json”,“授权”：的基本< auth-value >”,// Base64编码的"username:password"｝,数据：数据,｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python
进口请求进口jsonurl＝“https://example.亚博zendesk.com/api/v2/brands”有效载荷＝json．加载（”““{"品牌":{“name”:“Brand 1”，“子域名”:“Brand1”｝}”“”）头＝｛“内容类型”：“application / json”,｝响应＝请求．请求（“职位”,url,身份验证＝（“<用户名>”,' <密码> '）,头＝头,json＝有效载荷）打印（响应．文本）
Ruby
需要"net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/brands”）请求＝网：：HTTP：：帖子．新（uri,“内容类型”：“application / json”）请求．身体＝％问（｛“品牌”：｛“名称”：“1”品牌,“子域名”：“Brand1”｝｝）请求．basic_auth“用户名”,“密码”响应＝网：：HTTP．开始uri．主机名,uri．港口,use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
201年创建
//状态201已创建｛“品牌”：｛“活跃”：真正的,“brand_url”：“https://brand1.亚博zendesk.com”,“created_at”：“2019 - 08 - 06 - t02:43:39z”,“默认”：真正的,“has_help_center”：真正的,“help_center_state”：“启用”,“host_mapping”：“brand1.com”,“id”：360002783572,“is_deleted”：假,“标志”：｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/logos/brand1_logo.png”,“file_name”：“brand1_logo.png”,“id”：928374,“mapped_content_url”：“https://company.com/logos/brand1_logo.png”,“大小”：166144,“缩略图”：［｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/photos/brand1_logo_thumb.png”,“file_name”：“brand1_logo_thumb.png”,“id”：928375,“mapped_content_url”：“https://company.com/photos/brand1_logo_thumb.png”,“大小”：58298,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928375.json”｝,｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/photos/brand1_logo_small.png”,“file_name”：“brand1_logo_small.png”,“id”：928376,“mapped_content_url”：“https://company.com/photos/brand1_logo_small.png”,“大小”：58298,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928376.json”｝］,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928374.json”｝,“名称”：“1”品牌,“signature_template”：“{{agent.signature}}”,“子域名”：“hello world”,“ticket_form_ids”：［360000660811］,“updated_at”：“2019 - 08 - 06 - t02:43:40z”,“url”：“https://company.亚博zendesk.com/api/v2/brands/360002783572.json”｝｝
更新品牌
把/ api / v2 /品牌/ {brand_id}
返回一个更新后的品牌。
允许
- 管理员
更新品牌形象
可以通过使用更新品牌端点上传本地文件来更新品牌图像。看到使用旋度有关更多信息，请参见下面的部分。
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| brand_id | 整数 | 路径 | 真正的 | 品牌标识 |
例子的身体
｛“品牌”：｛“活跃”：真正的,“host_mapping”：“brand1.com”,“名称”：“1”品牌,“子域名”：“Brand1”｝｝
代码示例
旋度
使用JSON更新品牌细节。
旋度https://｛子域名｝.亚博zendesk.com/api/v2/brands/｛brand_id｝. json＼- h“application / json内容类型:- x将＼- d“{”牌”:{“名称”:“1”品牌,“子域名”:“brand1”“host_mapping”:“brand1.com”,“活动”:真正}}”＼- v - u｛email_address｝：｛密码｝｝
旋度
通过上传本地形象文件更新品牌形象。
旋度- v - u｛email_address｝：｛密码｝- x将＼- f“品牌(商标)[uploaded_data](电子邮件保护)/道路/ /图像/ image.jpg”＼https://｛子域名｝.亚博zendesk.com/api/v2/brands/｛brand_id｝. json
去
进口（“fmt”“输入输出”"net/http”“弦”）函数主要（）｛url: =“https://example.亚博zendesk.com/api/v2/brands/360002783572”方法: =“把”有效载荷: =字符串．NewReader（”{"品牌":{“活跃”:没错,“host_mapping”:“brand1.com”,“name”:“Brand 1”，“子域名”:“Brand1”｝} '）要求的事情,犯错: =http．NewRequest（方法,url,有效载荷）如果犯错! =零｛fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”,“application / json”）要求的事情．头．添加（“授权”,“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http．客户端｛｝res,犯错: =客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体,犯错: =io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Nodejs
varaxios＝需要（“axios”）；var数据＝JSON．stringify（｛“品牌”：｛“活跃”：真正的,“host_mapping”：“brand1.com”,“名称”：“1”品牌,“子域名”：“Brand1”｝｝）；var配置＝｛方法：“把”,url：“https://example.亚博zendesk.com/api/v2/brands/360002783572”,头：｛“内容类型”：“application / json”,“授权”：的基本< auth-value >”,// Base64编码的"username:password"｝,数据：数据,｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python
进口请求进口jsonurl＝“https://example.亚博zendesk.com/api/v2/brands/360002783572”有效载荷＝json．加载（”““{"品牌":{“活跃”:没错,“host_mapping”:“brand1.com”,“name”:“Brand 1”，“子域名”:“Brand1”｝}”“”）头＝｛“内容类型”：“application / json”,｝响应＝请求．请求（“把”,url,身份验证＝（“<用户名>”,' <密码> '）,头＝头,json＝有效载荷）打印（响应．文本）
Ruby
需要"net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/brands/360002783572”）请求＝网：：HTTP：：把．新（uri,“内容类型”：“application / json”）请求．身体＝％问（｛“品牌”：｛“活跃”：真正的,“host_mapping”：“brand1.com”,“名称”：“1”品牌,“子域名”：“Brand1”｝｝）请求．basic_auth“用户名”,“密码”响应＝网：：HTTP．开始uri．主机名,uri．港口,use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
// Status 200 OK｛“品牌”：｛“活跃”：真正的,“brand_url”：“https://brand1.亚博zendesk.com”,“created_at”：“2019 - 08 - 06 - t02:43:39z”,“默认”：真正的,“has_help_center”：真正的,“help_center_state”：“启用”,“host_mapping”：“brand1.com”,“id”：360002783572,“is_deleted”：假,“标志”：｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/logos/brand1_logo.png”,“file_name”：“brand1_logo.png”,“id”：928374,“mapped_content_url”：“https://company.com/logos/brand1_logo.png”,“大小”：166144,“缩略图”：［｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/photos/brand1_logo_thumb.png”,“file_name”：“brand1_logo_thumb.png”,“id”：928375,“mapped_content_url”：“https://company.com/photos/brand1_logo_thumb.png”,“大小”：58298,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928375.json”｝,｛“content_type”：“图像/ png”,“content_url”：“https://company.亚博zendesk.com/photos/brand1_logo_small.png”,“file_name”：“brand1_logo_small.png”,“id”：928376,“mapped_content_url”：“https://company.com/photos/brand1_logo_small.png”,“大小”：58298,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928376.json”｝］,“url”：“https://company.亚博zendesk.com/api/v2/attachments/928374.json”｝,“名称”：“1”品牌,“signature_template”：“{{agent.signature}}”,“子域名”：“hello world”,“ticket_form_ids”：［360000660811］,“updated_at”：“2019 - 08 - 06 - t02:43:40z”,“url”：“https://company.亚博zendesk.com/api/v2/brands/360002783572.json”｝｝
删除品牌
删除/ api / v2 /品牌/ {brand_id}
删除品牌。
允许
- 管理员
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| brand_id | 整数 | 路径 | 真正的 | 品牌标识 |
代码示例
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/brands/｛brand_id｝. json＼-X DELETE -v -u｛email_address｝：｛密码｝
去
进口（“fmt”“输入输出”"net/http”）函数主要（）｛url: =“https://example.亚博zendesk.com/api/v2/brands/360002783572”方法: =“删除”要求的事情,犯错: =http．NewRequest（方法,url,零）如果犯错! =零｛fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”,“application / json”）要求的事情．头．添加（“授权”,“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http．客户端｛｝res,犯错: =客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体,犯错: =io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Nodejs
varaxios＝需要（“axios”）；var配置＝｛方法：“删除”,url：“https://example.亚博zendesk.com/api/v2/brands/360002783572”,头：｛“内容类型”：“application / json”,“授权”：的基本< auth-value >”,// Base64编码的"username:password"｝,｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python
进口请求url＝“https://example.亚博zendesk.com/api/v2/brands/360002783572”头＝｛“内容类型”：“application / json”,｝响应＝请求．请求（“删除”,url,身份验证＝（“<用户名>”,' <密码> '）,头＝头）打印（响应．文本）
Ruby
需要"net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/brands/360002783572”）请求＝网：：HTTP：：删除．新（uri,“内容类型”：“application / json”）请求．basic_auth“用户名”,“密码”响应＝网：：HTTP．开始uri．主机名,uri．港口,use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
204无内容
//状态204无内容零
检查主机映射的有效性
GET / api / v2 /品牌/ check_host_mapping吗?host_mapping＝｛host_mapping｝＆子域名＝｛子域名｝
返回一个JSON对象，确定主机映射对给定子域是否有效。
允许
- 管理员
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| host_mapping | 字符串 | 查询 | 真正的 | 到某个品牌的主机映射(如果有的话)(只有管理员才能查看该键) |
| 子域名 | 字符串 | 查询 | 真正的 | 指定Zendesk帐户地址的子域亚博 |
代码示例
旋度
旋度“https://{子域名}.zendes亚博k.com/api/v2/brands/check_host_mapping.json ? host_mapping = {host_mapping}子域名={子域名}'＼- v - u｛email_address｝：｛密码｝
去
进口（“fmt”“输入输出”"net/http”）函数主要（）｛url: =“https://example.亚博zendesk.com/api/v2/brands/check_host_mapping?host_mapping=brand1.com&subdomain=Brand1”方法: =“获得”要求的事情,犯错: =http．NewRequest（方法,url,零）如果犯错! =零｛fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”,“application / json”）要求的事情．头．添加（“授权”,“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http．客户端｛｝res,犯错: =客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体,犯错: =io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Nodejs
varaxios＝需要（“axios”）；var配置＝｛方法：“得到”,url：“https://example.亚博zendesk.com/api/v2/brands/check_host_mapping”,头：｛“内容类型”：“application / json”,“授权”：的基本< auth-value >”,// Base64编码的"username:password"｝,参数个数：｛“host_mapping”：“brand1.com”,“子域名”：“Brand1”,｝,｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python
进口请求url＝“https://example.亚博zendesk.com/api/v2/brands/check_host_mapping?host_mapping=brand1.com&subdomain=Brand1”头＝｛“内容类型”：“application / json”,｝响应＝请求．请求（“获得”,url,身份验证＝（“<用户名>”,' <密码> '）,头＝头）打印（响应．文本）
Ruby
需要"net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/brands/check_host_mapping”）uri．查询＝URI．encode_www_form（“host_mapping”：“brand1.com”,“子域名”：“Brand1”）请求＝网：：HTTP：：得到．新（uri,“内容类型”：“application / json”）请求．basic_auth“用户名”,“密码”响应＝网：：HTTP．开始uri．主机名,uri．港口,use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
// Status 200 OK｛“cname”：“bar.亚博zendesk.com”,“is_valid”：真正的｝
检查已有品牌的主机映射有效性
GET / api / v2 /品牌/ {brand_id} / check_host_mapping
返回一个JSON对象，确定主机映射对给定品牌是否有效。
允许
- 管理员
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| brand_id | 整数 | 路径 | 真正的 | 品牌标识 |
代码示例
旋度
旋度“https://{子域名}.zendes亚博k.com/api/v2/brands/ {brand_id} / check_host_mapping.json”＼- v - u｛email_address｝：｛密码｝
去
进口（“fmt”“输入输出”"net/http”）函数主要（）｛url: =“https://example.亚博zendesk.com/api/v2/brands/360002783572/check_host_mapping”方法: =“获得”要求的事情,犯错: =http．NewRequest（方法,url,零）如果犯错! =零｛fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”,“application / json”）要求的事情．头．添加（“授权”,“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http．客户端｛｝res,犯错: =客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体,犯错: =io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Nodejs
varaxios＝需要（“axios”）；var配置＝｛方法：“得到”,url：“https://example.亚博zendesk.com/api/v2/brands/360002783572/check_host_mapping”,头：｛“内容类型”：“application / json”,“授权”：的基本< auth-value >”,// Base64编码的"username:password"｝,｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python
进口请求url＝“https://example.亚博zendesk.com/api/v2/brands/360002783572/check_host_mapping”头＝｛“内容类型”：“application / json”,｝响应＝请求．请求（“获得”,url,身份验证＝（“<用户名>”,' <密码> '）,头＝头）打印（响应．文本）
Ruby
需要"net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/brands/360002783572/check_host_mapping”）请求＝网：：HTTP：：得到．新（uri,“内容类型”：“application / json”）请求．basic_auth“用户名”,“密码”响应＝网：：HTTP．开始uri．主机名,uri．港口,use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
// Status 200 OK｛“cname”：“bar.亚博zendesk.com”,“is_valid”：真正的｝