探索Zendesk 亚博api与邮差
邮递员是一款测试api的流行应用。本文解释了如何设置Postman来发出Zendesk API请求。亚博
免责声明:亚博Zendesk不支持Postman或其他第三方工具。如需帮助,请参阅邮差文档。
你需要什么?
要将Postman与Zendesk api一起使亚博用,您需要以下内容:
Ze亚博ndesk账户
一个免费的邮差帐户
你可以将Postman作为web或桌面应用程序使用。本文使用web应用程序。要安装桌面应用程序,请参见安装及更新邮差在Postman文档中。
fork Zende亚博sk API集合
Postman对API端点进行分组和组织集合。收藏被安置在工作区。当您创建一个Postman帐户时,Postman会为您创建一个个人工作空间。默认情况下,此工作空间仅对您可见。
的亚博Zendesk公共API工作区是一个公共工作区,用于发布Zendesk api的集合。亚博这个工作区中的集合由Zendesk管理,任何人都可以看到。亚博
要使用来自Zendesk Public API工作区的集合亚博,首先需要fork这个集合。分叉将集合的副本保存到您的一个工作区,例如您的个人工作区。这可以让你做以下事情:
使用集合中亚博的端点发送Zendesk API请求。您不能从公共工作区发送请求。
对集合进行更改,例如配置授权或变量,而不影响公共版本。
创建把请求为集合的公共版本提供错误修复。
公开你的Postman个人资料
要从公共工作区派生一个集合,必须将Postman配置文件设置为公共。这可以让其他人看到你的fork和你所做的任何公共贡献。有关公共配置文件的更多信息,请参见公开个人资料在Postman文档中。
使用“输入邮差”按钮
大多数介绍页在亚博Zendesk API参考,例如票务的介绍和帮助中心简介,包括邮差跑进来按钮。您可以使用此按钮将相关API的集合派生到您的工作区中。
使用“Run in Postman”按钮fork一个集合
在Zendesk API参考的介绍页面上,单击亚博邮差跑进来按钮。例子:
这将打开一个包含Fork collection到您的工作区模态。
点击叉集合。
如果出现提示,登录到Postman。
在叉集合页,输入叉的标签然后选择一个工作空间。
点击叉集合。
如果出现提示,将您的个人资料公开。从Zendesk公共API工作区派生一个集合需要一个公共配置文件。亚博
该集合出现在您选择的工作区的侧栏中。
同步分叉集合
亚博Zendesk定期更新Zendesk公共API工作区中的集合,以添加功能,删除已弃用的特性,并修复错误。你可以把这些更新拉到你的分支中。
同步一个分叉的集合
在左侧栏中,单击more actions图标()旁边的集合名称。
点击把变化。
查看diff并单击把变化。
配置集合
在发出API请求之前,为您的分叉集合配置以下设置:
授权
配置对集合端点的请求所使用的身份验证方法和凭据。有关支持的身份验证方法的详细信息,请参见安全性和身份验证在Zendes亚博k API参考中。
为集合配置授权
在左侧栏中,单击more actions图标()旁边的集合名称。
点击编辑。
单击授权选项卡。
如果使用基本身份验证或API令牌,请选择基本认证使用类型下拉。
如果您使用的是基本身份验证,请输入您的Zendesk电子邮件地址和密码。亚博
如果您使用API令牌,请在您的电子邮件地址后面添加“/token”,并输入API令牌作为密码。
如果您使用OAuth访问令牌,在类型下拉选项,选择不记名的令牌,并输入令牌。
单击保存图标()。
变量
亚博Zendesk API集合使用变量来构建API请求的基本URL。这些变量的值取决于API和您的Zendesk帐户。亚博
设置变量值
在左侧栏中,单击more actions图标()旁边的集合名称。
点击编辑。
单击变量选项卡。
在变量选项卡,设置当前值对于集合的变量。
如果集合只有baseUrl变量,使用值“https://{subdomain}.zendesk.com”。亚博将“{subdomain}”替换为Zendesk子域。亚博
重要的是:对于Chat API,使用abaseUrl的价值https://www.zopim.com”。对于Sell api,使用abaseUrl的价值https://api.getbase.com”。
如果集合有宿主,子域名,baseUrl变量,设置宿主“zen亚博desk”和子域名到Zendesk亚博子域。离开baseUrl值为“https://{{subdomain}}.{{host}}.com”。
点击保存所有。这将设置每个变量的当前值随着初始值。
单击保存图标()。
发出Zendesk亚博 API请求
配置分叉集合之后,可以使用Postman使用集合的端点发送Zendesk API请求。亚博
发出Zendesk 亚博API请求