基本信息
接口名称: 获取邀请链接结果
接口类型: 数据获取
接口说明: 获取邀请链接传入的所有参数结果
详细信息
URL
https://www.baklib.com/api/v1/tenants/:tennat_id/invert_users
完整URL示例
https://www.baklib.com/api/v1/tenants/aaa24dbe-a17b-4439-911d-176e0149cf76/invert_users
HTTP请求方式
GET
授权认证方式
默认方式,需要添加请求header
Authorization: Bearer <token>
请求参数
参数 | 必选 | 类型及范围 | 说明 |
---|---|---|---|
id | true | String | 站点id |
_page | false | Integer | 需要显示的页码 |
_per_page | false | Integer | 每页显示数量, 默认10, 最大不能超过50 |
站点id 可以通过站点列表接口获得。
点击获得站点id
示例代码
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://www.baklib.com/api/v1/tenants/aaa24dbe-a17b-4439-911d-176e0149cf76/invert_users");
xhr.setRequestHeader("Authorization", "Bearer 8486df9cb8a93ea843702141065c4a8b714602b45e7c4a6bb26a26ea3d69de6");
xhr.send();
返回结果
{
"code": 0,
"status": "success",
"message": {
"meta": {
"current_page": 1,
"total_pages": 0,
"total_count": 0
},
"items": []
}
}
返回字段说明
返回值字段 | 字段类型 | 说明 |
---|---|---|
code | Integer | 状态码 |
status | String | 返回状态 |
message | Hash | 返回数据 |
meta | Jsonb | 元数据 |
current_page | Integer | 当前页码 |
total_pages | Integer | 页面总数 |
total_count | Integer | 结果总数 |
items | Array[String] | 数据项 |