应用程序的位置
有关位置的更多信息,请参见设置应用程序位置在应用程序开发者文档中。
JSON格式
应用程序位置表示为JSON对象,具有以下属性:
名字 | 类型 | 只读 | 强制性的 | 描述 |
---|---|---|---|---|
可折叠的 | 布尔 | 真正的 | 假 | 如果重新排序有影响,则该值为true |
host_application | 字符串 | 真正的 | 假 | 唯一的主机应用程序密钥 |
id | 整数 | 真正的 | 假 | 内部位置ID |
名字 | 字符串 | 真正的 | 假 | 唯一的位置键 |
orderable | 布尔 | 真正的 | 假 | 如果重新排序有影响,则该值为true |
product_code | 整数 | 真正的 | 假 | 内部产品ID |
可见 | 布尔 | 真正的 | 假 | 如果用户可以看到并访问位置,则该值为true |
例子
{
“折叠”:真正的,
“host_application”:“亚博zendesk”,
“id”:1,
“名称”:“top_bar”,
“公开”定货:真正的,
“product_code”:1,
“可见”:真正的
}
位置列表
GET / api / v2 /应用程序/位置
返回Zendesk应用程序的可用位置列表。亚博
允许
- 管理员
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/apps/locations.json\
- u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url: =“https://support.亚博zendesk.com/api/v2/apps/locations”
方法: =“获得”
要求的事情,犯错: =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://support.亚博zendesk.com/api/v2/apps/locations”)
.newBuilder();
请求请求=新请求.构建器()
.url(urlBuilder.构建())
.方法(“获得”,零)
.addHeader(“内容类型”,“application / json”)
.addHeader(“授权”,凭证.基本(“电子邮件”,“你的密码”))
.构建();
响应响应=客户端.newCall(请求).执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://support.亚博zendesk.com/api/v2/apps/locations”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/apps/locations”
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“获得”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应.文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/apps/locations”)
请求=网::HTTP::得到.新(uri,“内容类型”:“application / json”)
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
200好了
// Status 200 OK
{
“位置”:[
{
“host_application”:“亚博zendesk”,
“id”:1,
“名称”:“top_bar”,
“公开”定货:真正的
},
{
“host_application”:“亚博zendesk”,
“id”:2,
“名称”:“nav_bar”,
“公开”定货:真正的
},
{
“host_application”:“亚博zendesk”,
“id”:3.,
“名称”:“ticket_sidebar”,
“公开”定货:真正的
},
{
“host_application”:“亚博zendesk”,
“id”:4,
“名称”:“new_ticket_sidebar”,
“公开”定货:真正的
},
{
“host_application”:“亚博zendesk”,
“id”:5,
“名称”:“user_sidebar”,
“公开”定货:真正的
}
]
}
显示位置
GET / api / v2 /应用程序/地点/ {app_location_id}
允许
- 管理员
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
app_location_id | 整数 | 路径 | 真正的 | 应用程序位置的ID |
代码示例
旋度
旋度https://{子域名}.亚博zendesk.com/api/v2/apps/locations/{app_location_id}. json\
- u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url: =“https://support.亚博zendesk.com/api/v2/apps/locations/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://support.亚博zendesk.com/api/v2/apps/locations/1”)
.newBuilder();
请求请求=新请求.构建器()
.url(urlBuilder.构建())
.方法(“获得”,零)
.addHeader(“内容类型”,“application / json”)
.addHeader(“授权”,凭证.基本(“电子邮件”,“你的密码”))
.构建();
响应响应=客户端.newCall(请求).执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://support.亚博zendesk.com/api/v2/apps/locations/1”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/apps/locations/1”
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“获得”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应.文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/apps/locations/1”)
请求=网::HTTP::得到.新(uri,“内容类型”:“application / json”)
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
200好了
// Status 200 OK
{
“位置”:{
“host_application”:“亚博zendesk”,
“id”:1,
“名称”:“top_bar”
}
}