文档 API参考

共享协议

门票可以在Zendesk帐户之间共享。亚博为了实现机票共享，共享协议必须由一个帐户发送，并由另一个帐户接受。共享协议的工作原理如下:

  • 任何Ze亚博ndesk帐户都可以邀请其他帐户建立共享协议。
  • 发起账户(发送方)设置共享协议的条款，接收账户可以接受或不接受。
  • 共享协议是一种方式。接收方接受协议后，发送方可以与接收方共享票据。如果接收方想要与发送方共享票据，他们必须创建共享协议并将其发送到另一个账户。

要了解更多信息，请参见与其他Zendesk帐户共享门票亚博在Ze亚博ndesk帮助。

JSON格式

共享协议用JSON对象表示，具有以下属性:

名字 类型 只读 强制性的 描述
created_at 字符串 真正的 假 记录被创造的时间
id 整数 真正的 假 创建时自动分配
名字 字符串 假 假 此共享协议的名称
partner_name 字符串 假 假 可以是以下任意一种:"jira"， null
remote_subdomain 字符串 假 假 远程帐户的子域，如果未与帐户关联，则为空
状态 字符串 假 假 可以是以下选项之一:"accepted"， "declined"， "pending"， "inactive"， "failed"， "ssl_error"， "configuration_error"
类型 字符串 假 假 可以是以下之一:“入站”，“出站”
url 字符串 真正的 假 共享协议记录的URL

例子

             

              
｛“created_at”：“2012 - 02年- 20 - t22:55:29z”，“id”：88335，“名称”：“票分享”，“partner_name”：“jira”，“状态”：“接受”，“类型”：“入站”，“url”：“https://company.亚博zendesk.com/api/v2/agreements/88335.json”}

列表共享协议

  • GET / api / v2 / sharing_agreements

允许

  • 代理

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/sharing_agreements.json\- v - u｛email_address}：｛密码}
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://example.亚博zendesk.com/api/v2/sharing_agreements”方法：=“获得”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零｛fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=&http．客户端｛}res，犯错：=客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java 
              

               
进口com．squareup．okhttp．＊；OkHttpClient客户端＝新OkHttpClient（）；HttpUrl．构建器urlBuilder＝HttpUrl．解析（“https://example.亚博zendesk.com/api/v2/sharing_agreements”）．newBuilder（）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios＝需要（“axios”）；var配置＝｛方法：“得到”，url：“https://example.亚博zendesk.com/api/v2/sharing_agreements”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）｛控制台．日志（错误）；}）；
Python 
              

               
进口请求url＝“https://example.亚博zendesk.com/api/v2/sharing_agreements”头＝｛“内容类型”：“application / json”，}响应＝请求．请求（“获得”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/sharing_agreements”）请求＝网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK｛“sharing_agreements”：［｛“created_at”：“2012 - 02年- 20 - t22:55:29z”，“id”：1，“名称”：“Foo @ 亚博Zendesk”，“partner_name”：“jira”，“状态”：“接受”，“类型”：“入站”，“url”：“https://company.亚博zendesk.com/api/v2/agreements/1.json”}]}

出示共享协议

  • GET / api / v2 / sharing_agreements / {sharing_agreement_id}

返回您帐户的共享协议。

允许

  • 代理

参数

名字 类型 在 要求 描述
sharing_agreement_id 整数 路径 真正的 共享协议的ID

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/sharing_agreements/｛sharing_agreement_id}. json\- v - u｛email_address}：｛密码}
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”方法：=“获得”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零｛fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=&http．客户端｛}res，犯错：=客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java 
              

               
进口com．squareup．okhttp．＊；OkHttpClient客户端＝新OkHttpClient（）；HttpUrl．构建器urlBuilder＝HttpUrl．解析（“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”）．newBuilder（）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios＝需要（“axios”）；var配置＝｛方法：“得到”，url：“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）｛控制台．日志（错误）；}）；
Python 
              

               
进口请求url＝“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”头＝｛“内容类型”：“application / json”，}响应＝请求．请求（“获得”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”）请求＝网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK｛“sharing_agreement”：｛“created_at”：“2012 - 02年- 20 - t22:55:29z”，“id”：1，“名称”：“Foo @ 亚博Zendesk”，“partner_name”：零，“remote_subdomain”：“foo”，“状态”：“接受”，“类型”：“入站”，“url”：“https://company.亚博zendesk.com/api/v2/agreements/1.json”}}

创建共享协议

  • POST / api / v2 / sharing_agreements

允许

  • 管理员

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/sharing_agreements.json\- h“application / json内容类型:- x的帖子\- d”{sharing_agreement”:{“remote_subdomain”:“Foo”}}”\- v - u｛email_address}：｛密码}
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://example.亚博zendesk.com/api/v2/sharing_agreements”方法：=“职位”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零｛fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=&http．客户端｛}res，犯错：=客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java 
              

               
进口com．squareup．okhttp．＊；OkHttpClient客户端＝新OkHttpClient（）；HttpUrl．构建器urlBuilder＝HttpUrl．解析（“https://example.亚博zendesk.com/api/v2/sharing_agreements”）．newBuilder（）；RequestBody身体＝RequestBody．创建（MediaType．解析（“application / json”），”“＂”“＂）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“职位”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios＝需要（“axios”）；var配置＝｛方法：“职位”，url：“https://example.亚博zendesk.com/api/v2/sharing_agreements”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）｛控制台．日志（错误）；}）；
Python 
              

               
进口请求url＝“https://example.亚博zendesk.com/api/v2/sharing_agreements”头＝｛“内容类型”：“application / json”，}响应＝请求．请求（“职位”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/sharing_agreements”）请求＝网：：HTTP：：帖子．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

201年创建 
              

               
//状态201创建｛“sharing_agreement”：｛“created_at”：“2012 - 02年- 20 - t22:55:29z”，“id”：1，“名称”：“Foo @ 亚博Zendesk”，“partner_name”：零，“remote_subdomain”：“foo”，“状态”：“接受”，“类型”：“入站”，“url”：“https://company.亚博zendesk.com/api/v2/agreements/1.json”}}

更新共享协议

  • 把/ api / v2 / sharing_agreements / {sharing_agreement_id}

返回更新后的共享协议。只有状态允许更新。

允许

  • 管理员

参数

名字 类型 在 要求 描述
sharing_agreement_id 整数 路径 真正的 共享协议的ID

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/sharing_agreements/｛sharing_agreement_id}. json\- h“application / json内容类型:- x将\- d'{"sharing_agreement": {"status": "accepted"}}'\- v - u｛email_address}：｛密码}
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”方法：=“把”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零｛fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=&http．客户端｛}res，犯错：=客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java 
              

               
进口com．squareup．okhttp．＊；OkHttpClient客户端＝新OkHttpClient（）；HttpUrl．构建器urlBuilder＝HttpUrl．解析（“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”）．newBuilder（）；RequestBody身体＝RequestBody．创建（MediaType．解析（“application / json”），”“＂”“＂）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“把”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios＝需要（“axios”）；var配置＝｛方法：“把”，url：“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）｛控制台．日志（错误）；}）；
Python 
              

               
进口请求url＝“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”头＝｛“内容类型”：“application / json”，}响应＝请求．请求（“把”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”）请求＝网：：HTTP：：把．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK｛“sharing_agreement”：｛“created_at”：“2012 - 02年- 20 - t22:55:29z”，“id”：1，“名称”：“Foo @ 亚博Zendesk”，“partner_name”：零，“remote_subdomain”：“foo”，“状态”：“接受”，“类型”：“入站”，“url”：“https://company.亚博zendesk.com/api/v2/agreements/1.json”}}

删除共享协议

  • 删除/ api / v2 / sharing_agreements / {sharing_agreement_id}

删除共享协议。

允许

  • 管理员

参数

名字 类型 在 要求 描述
sharing_agreement_id 整数 路径 真正的 共享协议的ID

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/sharing_agreements/｛sharing_agreement_id}. json\删除-v -u｛email_address}：｛密码}
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”方法：=“删除”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零｛fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=&http．客户端｛}res，犯错：=客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java 
              

               
进口com．squareup．okhttp．＊；OkHttpClient客户端＝新OkHttpClient（）；HttpUrl．构建器urlBuilder＝HttpUrl．解析（“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”）．newBuilder（）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“删除”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios＝需要（“axios”）；var配置＝｛方法：“删除”，url：“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）｛控制台．日志（错误）；}）；
Python 
              

               
进口请求url＝“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”头＝｛“内容类型”：“application / json”，}响应＝请求．请求（“删除”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri＝URI（“https://example.亚博zendesk.com/api/v2/sharing_agreements/1”）请求＝网：：HTTP：：删除．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

204无内容 
              

               
//状态204无内容零