ZIS配置存储用于ZIS集成的设置。有关更多信息,请参见子配置

邮差跑进来

如果你使用Postman,你可以将ZIS Configurations API端点作为一个集合导入到你的Postman应用中,然后尝试不同的请求来了解API是如何工作的。点击以下按钮开始:

邮差跑进来”></a></p>
             <p data-garden-id=如果你不使用邮差,你可以注册一个免费帐户邮递员的网站并下载应用程序。有关使用Postman与Zendesk api的更多信息,请参阅亚博探索Zendesk 亚博api与邮差

JSON格式

配置被表示为具有以下属性的JSON对象:

名字 类型 只读 强制性的 描述
配置 对象 配置JSON对象。其他属性是元数据
created_at 字符串 真正的 创建配置的日期和时间
id 整数 真正的 配置的唯一ID
集成 字符串 真正的 配置所属的集成名称
范围 字符串 配置所属范围的名称
updated_at 字符串 真正的 最后一次更新配置的日期和时间
亚博zendesk_account_id 整数 真正的 配置所属亚博的Zendesk帐户ID

显示配置

  • GET / api /服务/子/集成/{集成}/配置?过滤器(范围)={过滤器(范围)}

返回集成的配置设置。的过滤器(范围)参数接受星号()作为通配符来匹配多个作用域。例子:过滤器(范围)= foo *.当与客户子域一起使用时,查找的范围限定为帐户。

身份验证

您可以使用OAuth访问令牌.Ze亚博ndesk应用程序也可以使用管理员的浏览器会话授权到该端点的请求。看到从Zendesk应用程序发出API请求亚博

参数

名字 类型 要求 描述
过滤器(范围) 字符串 查询 真正的 配置所属的集成范围
页面(后) 整数 查询 指定返回的页的起始位置
页面(大小) 整数 查询 要返回的配置数。每页最多返回100条记录
集成 字符串 路径 真正的 集成的名称。

代码示例

旋度
              
旋度“https://{子域名}.zendes亚博k.com/api/services/zis/integrations/{集成}/配置?过滤器(范围)= my_scope '- g - h"授权:Bearer {access_token}"
旋度
              
旋度“https://{子域名}.zendes亚博k.com/api/services/zis/integrations/{集成}/配置?过滤器(范围)= my_scope&page(大小)= 2”- g - h"授权:Bearer {access_token}"
              
进口“fmt”“输入输出”“net/http”函数主要{url: =“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs?filter(范围)=过滤器% 5 bscope % 5 d % 3 dmy_scope&page[在]=和页面大小=”方法: =“获得”要求的事情犯错: =httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”客户端: =http客户端{}res犯错: =客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错: =ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs”newBuilderaddQueryParameter“过滤器”(范围)“过滤器(范围)= my_scope”addQueryParameter“页面(后)””“addQueryParameter“页面大小””“请求请求=请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置={方法“得到”url“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs”{“内容类型”“application / json”}参数个数{的过滤器(范围)“过滤器% 5 bscope % 5 d % 3 dmy_scope '的页面(后)页面(大小)的}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs?filter(范围)=过滤器% 5 bscope % 5 d % 3 dmy_scope&page[在]=和页面大小=”={“内容类型”“application / json”}响应=请求请求“获得”url=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs”uri查询=URIencode_www_form“过滤器”(范围)“过滤器(范围)= my_scope”“页面(后)””““页面大小””“请求=HTTP得到uri“内容类型”“application / json”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“配置”{“配置”{“描述”“配置对象可以是任何东西,这是一个例子。”“id”999“名称”“my_config”}“created_at”“2021 - 08 - 30 - t04:40:17z”“id”1“集成”“my_integration”“范围”“my_scope”“updated_at”“2021 - 08 - 31 - t04:40:17z”“亚博zendesk_account_id”123}“链接”{“下一个””“}“元”{“has_more”真正的}“下一个”}
400错误请求
              
//状态400错误请求{“错误”{“代码”“1100”“细节”“坏请求”“状态”“400”}}
401年未经授权
              
//状态401未授权{“错误”{“代码”“1110”“细节”“验证失败”“状态”“401”}}
404未找到
              
//状态404未找到{“错误”{“代码”“1110”“细节”“没有找到”“状态”“404”}}

创建配置

  • POST / api /服务/子/集成/{集成}/款

为集成创建配置设置。

身份验证

您可以使用OAuth访问令牌.Ze亚博ndesk应用程序也可以使用管理员的浏览器会话授权到该端点的请求。看到从Zendesk应用程序发出API请求亚博

参数

名字 类型 要求 描述
集成 字符串 路径 真正的 集成的名称。

例子的身体

             
{“配置”{“描述”“配置对象可以是任何东西,这是一个例子。”“id”999“名称”“my_config”}“范围”“my_scope”}

代码示例

旋度
              
旋度- x的帖子“https://{子域名}.zendes亚博k.com/api/services/zis/integrations/{集成}/款'- h"授权:Bearer {access_token}"- h“application / json内容类型:- d{"配置":{"description": "一个配置对象可以是任何东西,这是一个例子。"“id”:999年,“名称”:“my_config”},“范围”:“my_scope”} '
              
进口“fmt”“输入输出”“net/http”“弦”函数主要{url: =“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs”方法: =“职位”有效载荷: =字符串NewReader”{"配置":{"description": "一个配置对象可以是任何东西,这是一个例子。"“id”:999年,“名称”:“my_config”},“范围”:“my_scope”} '要求的事情犯错: =httpNewRequest方法url有效载荷如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”客户端: =http客户端{}res犯错: =客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错: =ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs”newBuilderRequestBody身体=RequestBody创建MediaType解析“application / json””“{\ " config \”{\ \“描述”\”一个配置对象可以是任何东西一个例子\”\ \“id”999\“\”my_config \“\”}\ \“范围”my_scope \“\”}”“请求请求=请求构建器urlurlBuilder构建方法“职位”身体addHeader“内容类型”“application / json”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var数据=JSONstringify{“配置”{“描述”“配置对象可以是任何东西,这是一个例子。”“id”999“名称”“my_config”}“范围”“my_scope”}var配置={方法“职位”url“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs”{“内容类型”“application / json”}数据数据}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求进口jsonurl=“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs”有效载荷=json加载”““{"配置":{"description": "一个配置对象可以是任何东西,这是一个例子。"“id”:999年,“名称”:“my_config”},“范围”:“my_scope”}”“”={“内容类型”“application / json”}响应=请求请求“职位”url=json=有效载荷打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs”请求=HTTP帖子uri“内容类型”“application / json”请求身体={“配置”{“描述”“配置对象可以是任何东西,这是一个例子。”“id”999“名称”“my_config”}“范围”“my_scope”}响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

201年创建
              
//状态201创建{“配置”{“配置”{“描述”“配置对象可以是任何东西,这是一个例子。”“id”999“名称”“my_config”}“created_at”“2021 - 08 - 30 - t04:40:17z”“id”1“集成”“my_integration”“范围”“my_integration”“updated_at”“2021 - 08 - 31 - t04:40:17z”“亚博zendesk_account_id”22}}
400错误请求
              
//状态400错误请求{“错误”{“代码”“1100”“细节”“坏请求”“状态”“400”}}
401年未经授权
              
//状态401未授权{“错误”{“代码”“1110”“细节”“验证失败”“状态”“401”}}
422不可处理实体
              
//状态422不可处理的实体{“错误”{“代码”“1110”“细节”“Unprocessable实体”“状态”“422”}}

更新配置

  • 把/ api /服务/子/集成/{集成}/配置/{范围}

更新集成的配置设置。

注意:提供的配置设置将完全覆盖现有配置。

身份验证

您可以使用OAuth访问令牌.Ze亚博ndesk应用程序也可以使用管理员的浏览器会话授权到该端点的请求。看到从Zendesk应用程序发出API请求亚博

参数

名字 类型 要求 描述
集成 字符串 路径 真正的 集成的名称。
范围 字符串 路径 真正的 配置所属范围的名称。特殊字符应在URL路径中进行URL编码。例如:"foo/bar"到"foo%2Fbar"

例子的身体

             
{“配置”{“描述”“配置对象可以是任何东西,这是一个例子。”“id”999“名称”“my_config”}}

代码示例

旋度
              
旋度- x将“https://{子域名}.zendes亚博k.com/api/services/zis/integrations/{集成}/配置/ foo_bar_baz1 '- h"授权:Bearer {access_token}"- h“application / json内容类型:- d'{"Config": {"enable_comment_sync": "false"}}'
              
进口“fmt”“输入输出”“net/http”“弦”函数主要{url: =“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”方法: =“把”有效载荷: =字符串NewReader”{"配置":{"description": "一个配置对象可以是任何东西,这是一个例子。"“id”:999年,“名称”:“my_config”}} '要求的事情犯错: =httpNewRequest方法url有效载荷如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”客户端: =http客户端{}res犯错: =客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错: =ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”newBuilderRequestBody身体=RequestBody创建MediaType解析“application / json””“{\ " config \”{\ \“描述”\”一个配置对象可以是任何东西一个例子\”\ \“id”999\“\”my_config \“\”}}”“请求请求=请求构建器urlurlBuilder构建方法“把”身体addHeader“内容类型”“application / json”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var数据=JSONstringify{“配置”{“描述”“配置对象可以是任何东西,这是一个例子。”“id”999“名称”“my_config”}}var配置={方法“把”url“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”{“内容类型”“application / json”}数据数据}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求进口jsonurl=“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”有效载荷=json加载”““{"配置":{"description": "一个配置对象可以是任何东西,这是一个例子。"“id”:999年,“名称”:“my_config”}}”“”={“内容类型”“application / json”}响应=请求请求“把”url=json=有效载荷打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”请求=HTTPuri“内容类型”“application / json”请求身体={“配置”{“描述”“配置对象可以是任何东西,这是一个例子。”“id”999“名称”“my_config”}}响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“配置”{“配置”{“描述”“配置对象可以是任何东西,这是一个例子。”“id”999“名称”“my_config”}“created_at”“2021 - 08 - 30 - t04:40:17z”“id”1“集成”“my_integration”“范围”“my_integration”“updated_at”“2021 - 08 - 31 - t04:40:17z”“亚博zendesk_account_id”22}}
400错误请求
              
//状态400错误请求{“错误”{“代码”“1100”“细节”“坏请求”“状态”“400”}}
401年未经授权
              
//状态401未授权{“错误”{“代码”“1110”“细节”“验证失败”“状态”“401”}}
422不可处理实体
              
//状态422不可处理的实体{“错误”{“代码”“1110”“细节”“Unprocessable实体”“状态”“422”}}

合并配置

  • 补丁/ api /服务/子/集成/{集成}/配置/{范围}

将提供的配置设置与现有配置合并。

身份验证

您可以使用OAuth访问令牌.Ze亚博ndesk应用程序也可以使用管理员的浏览器会话授权到该端点的请求。看到从Zendesk应用程序发出API请求亚博

参数

名字 类型 要求 描述
集成 字符串 路径 真正的 集成的名称。
范围 字符串 路径 真正的 配置所属范围的名称。特殊字符应在URL路径中进行URL编码。例如:"foo/bar"到"foo%2Fbar"

例子的身体

             
{“配置”{“描述”“配置对象可以是任何东西,这是一个例子。”“id”999“名称”“my_config”}}

代码示例

旋度
              
旋度- x片“https://{子域名}.zendes亚博k.com/api/services/zis/integrations/{集成}/配置/ foo_bar_baz1 '- h"授权:Bearer {access_token}"- h“application / json内容类型:- d'{"Config": {"enable_comment_sync": "false"}}'
              
进口“fmt”“输入输出”“net/http”“弦”函数主要{url: =“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”方法: =“补丁”有效载荷: =字符串NewReader”{"配置":{"description": "一个配置对象可以是任何东西,这是一个例子。"“id”:999年,“名称”:“my_config”}} '要求的事情犯错: =httpNewRequest方法url有效载荷如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”客户端: =http客户端{}res犯错: =客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错: =ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”newBuilderRequestBody身体=RequestBody创建MediaType解析“application / json””“{\ " config \”{\ \“描述”\”一个配置对象可以是任何东西一个例子\”\ \“id”999\“\”my_config \“\”}}”“请求请求=请求构建器urlurlBuilder构建方法“补丁”身体addHeader“内容类型”“application / json”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var数据=JSONstringify{“配置”{“描述”“配置对象可以是任何东西,这是一个例子。”“id”999“名称”“my_config”}}var配置={方法“补丁”url“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”{“内容类型”“application / json”}数据数据}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求进口jsonurl=“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”有效载荷=json加载”““{"配置":{"description": "一个配置对象可以是任何东西,这是一个例子。"“id”:999年,“名称”:“my_config”}}”“”={“内容类型”“application / json”}响应=请求请求“补丁”url=json=有效载荷打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”请求=HTTP补丁uri“内容类型”“application / json”请求身体={“配置”{“描述”“配置对象可以是任何东西,这是一个例子。”“id”999“名称”“my_config”}}响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“配置”{“配置”{“描述”“配置对象可以是任何东西,这是一个例子。”“id”999“名称”“my_config”}“created_at”“2021 - 08 - 30 - t04:40:17z”“id”1“集成”“my_integration”“范围”“my_integration”“updated_at”“2021 - 08 - 31 - t04:40:17z”“亚博zendesk_account_id”22}}
400错误请求
              
//状态400错误请求{“错误”{“代码”“1100”“细节”“坏请求”“状态”“400”}}
422不可处理实体
              
//状态422不可处理的实体{“错误”{“代码”“1110”“细节”“Unprocessable实体”“状态”“422”}}

删除配置

  • 删除/ api /服务/子/集成/{集成}/配置/{范围}

删除现有的配置设置。

身份验证

您可以使用OAuth访问令牌.Ze亚博ndesk应用程序也可以使用管理员的浏览器会话授权到该端点的请求。看到从Zendesk应用程序发出API请求亚博

参数

名字 类型 要求 描述
集成 字符串 路径 真正的 集成的名称。
范围 字符串 路径 真正的 配置所属范围的名称。特殊字符应在URL路径中进行URL编码。例如:"foo/bar"到"foo%2Fbar"

代码示例

旋度
              
旋度- x删除“https://{子域名}.zendes亚博k.com/api/services/zis/integrations/{集成}/配置/ my_scope”- h"授权:Bearer {access_token}"
              
进口“fmt”“输入输出”“net/http”函数主要{url: =“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”方法: =“删除”要求的事情犯错: =httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”客户端: =http客户端{}res犯错: =客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错: =ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”newBuilder请求请求=请求构建器urlurlBuilder构建方法“删除”addHeader“内容类型”“application / json”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置={方法“删除”url“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”{“内容类型”“application / json”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”={“内容类型”“application / json”}响应=请求请求“删除”url=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/services/zis/integrations/my_integration/configs/my_scope”请求=HTTP删除uri“内容类型”“application / json”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

204无内容
              
//状态204无内容
400错误请求
              
//状态400错误请求{“错误”{“代码”“1100”“细节”“坏请求”“状态”“400”}}
401年未经授权
              
//状态401未授权{“错误”{“代码”“1110”“细节”“验证失败”“状态”“401”}}
404未找到
              
//状态404未找到{“错误”{“代码”“1110”“细节”“没有找到”“状态”“404”}}