API概述
API访问认证
API访问认证过程
API客户端注册
获取访问Token
用AccessToken访问
API设计说明
用户管理
列出所有用户
查询单个用户
创建用户
修改用户
暂停用户
开启用户
用户分组信息
修改URL回调通知
网站监控
网站监控任务列表
查看监控任务配置
查看任务监控数据
创建网站监控任务
可使用的监测点
监测点运营商
修改监控任务配置
开启/停止监控任务
获取响应时间分布
删除网站监控任务
网站监控分组列表
创建网站监控分组
分配监控任务到分组
创建站点企业分组
分配任务到企业分组
查看最近一次的数据
查看历史快照
企业分组任务列表
网站子账号任务列表
服务监控
服务监控任务列表
查看监控任务配置
查看任务监控数据
创建服务监控任务
修改监控任务配置
开启/停止监控任务
删除服务监控任务
服务监控分组列表
创建服务监控分组
分配监控任务到分组
创建企业分组
分配任务到企业分组
查看任务统计数据
子账号监控任务列表
服务器监控
服务器监控任务列表
查看监控任务配置
查看任务监控数据
创建服务器监控任务
修改监控任务配置
开启/停止监控任务
删除服务器监控任务
服务器监控分组列表
创建个人监控分组
创建企业服务器分组
分配监控任务到分组
分配任务到企业分组
统计服务器数量
获取告警的服务器
查看任务统计数据
获取服务器的磁盘
获取服务器的网卡
告警设置
故障历史查询
网站监控告警设置
服务监控告警设置
服务器监控告警设置
获取任务告警消息
获取消息的通知历史
获取自定义告警消息
插件管理
插件列表
创建采集器
删除采集器
采集器任务统计
自定义告警
获取自定义告警规则
查看自定义告警规则
创建自定义告警规则
修改自定义告警规则
删除自定义告警规则
API监控
API监控任务列表
查看任务监控数据
查看最近一次的数据
API监控任务可用率
API监控任务响应时间
API监控任务正确率
API监控任务故障历史

客户端注册之后,可以凭借从监控宝获得的客户端ID和客户端密码来获取用于访问监控宝API服务的AccessToken和RefershToken。

n  AccessToken:访问监控宝API服务需要的Token,该Token对应于每个授权的客户端的每个监控宝用户

n  RefreshToken:在AccessToken过期之后,用于刷新AccessToken


一、获取AccessToken

通过下面的地址获取AccessToken:

https://api.jiankongbao.com/v2/oauth/token.json

请求参数:

参数

参数说明

grant_type

必选参数,必须是 password

username

必选参数,用户的监控宝帐号邮箱,例如: test@jiankongbao.com

password

必选参数,用户监控宝帐号的密码,使用md5加密,例如: e10adc3949ba59abbe56e057f20f883e

client_id

必选参数,注册的客户端Id

client_secret

必须参数,注册的客户端密码

* 发送的HTTP请求必须是POST方式,例如:

curl -s https://api.jiankongbao.com/v2/oauth/token.json --data "grant_type=password&username=test@jiankongbao.com&password=e10adc3949ba59abbe56e057f20f883e&client_id=demo_id
&client_secret=demo_secret"

请求成功返回结果:

{
"access_token":"c699242331bf041b57d207f6e410358c1a896e9d",
"expires_in":3600,  (token过期时间,单位秒)
"token_type":"bearer",
"scope":null,
"refresh_token":"a5827ee761c77e169a86643baa970cef33cc8c55"
}

请求失败返回结果:

{
"error":"invalid_client",  
"error_description":"The client credentials are invalid"
}

错误列表:

错误代码

错误说明

invalid_client

客户端id验证失败

invalid_grant

用户帐号验证失败 


二、获取刷新AccessToken

通过下面的地址获取刷新AccessToken:

https://api.jiankongbao.com/v2/oauth/token.json

请求参数:

参数

参数说明

grant_type

必选参数,必须是 refresh_token

client_id

必选参数,注册的客户端Id

client_secret

必须参数,注册的客户端密码

refresh_token

必选参数,当成功获取AccessToken的时候,返回结果里的refresh_token。

例如:a5827ee761c77e169a86643baa970cef33cc8c55

* 发送的HTTP请求必须是POST方式,例如:

curl -s https://api.jiankongbao.com/v2/oauth/token.json --data "grant_type=refresh_token&client_id=demo_id&client_secret=demo_secret&refresh_token=a5827ee761c77e169a86643baa970cef33cc8c55"

请求成功返回结果:

{
"access_token":"c699242331bf041b57d207f6e410358c1a896e9d",     
"expires_in":3600  (token过期时间,单位秒)                       
"token_type":"bearer",
"scope":null,
"refresh_token":"a5827ee761c77e169a86643baa970cef33cc8c55"
}

请求失败返回结果:

{
"error":"invalid_grant",
"error_description":"Invalid refresh token" (refresh token 验证失败)                       
}