tigase rest api的使用方法
2020-08-26tigase攻城狮3396°c
A+ A-tigase版本:8.0.0
最近在研究tigase,想要写个第三方服务做一些扩展功能,看到tigase自带了rest api,大喜若望,然而在用的时候,并不是那么顺畅,折腾了一上午,也算是弄通了,这里记录一下。
tigase提供的rest api列表可以在http://localhost:8080/rest/这个路径下看到这里就不再截图了,每个url需要post请求还是get请求一眼也能看出来,这里需要注意的地方就是所有api在请求的时候要在地址后面跟上一个参数api-key=xxxxxx,这里的api-key可以在你的管理员界面看到,打开地址http://localhost:8080/admin,正确登录进去后,左侧有个CONFIGURATION菜单,点击后会展开,然后再点击UPDATE API KEY,此时右侧显示的就是你的api-key,把那个复制出来就可以用(不能复制的,F12是个好东西):
此时你已经拿到你的api-key了
接下来是调用rest api的时候了,随便找个简单的,比如获取用户列表: http://localhost:8080/rest/users/, 前半段路径就是服务器路径,后半段就是rest api列表里面给出的,这是一个get请求,所以结合上面的api-key后,这个api的正确请求地址是:http://localhost:8080/rest/users?api-key=xxxxx
但是仅仅这样还不行,还需要设置两个参数在Header里面:
Content-Type:application/json
Authorization:Basic认证的字符串
其中,Content-Type的值有两个可选值,application/json 或者 application/xml 分别表示希望服务器以哪种格式返回给自己结果
而Authorization的值,是你登录admin模块的时候用到的管理员的用户名和密码的base64串,比如,你的用户名是[email protected] 密码是 123,那么就对 [email protected]:123 这个字符串进行base64编码,拿到编码结果后前面再加上Basic 就是Authorization的值了。(注意Basic后面要加一个空格)
经过上面的操作后,就可以正确的请求到tigase提供的rest api了。