IT桔子开放接口说明文档

• 编写时间：2020-11-11

• 更新时间：2025-03-13

• 版本：3.5.8

简介

接口采用Oauth2.0协议, 分配不同的appid和appkey来标识不同用户的身份。所列接口未做特殊说明的, 均支持POST和GET两种请求方式。

接口分为身份认证接口和数据业务接口两类
其中身份认证接口用于验证用户身份并为用户分配认证token。
数据业务类接口用于调用返回业务数据。

测试接口域名：https://dev_openapi.itjuzi.com
正式接口(购买接口后)域名：https://openapi.itjuzi.com
请求时的路径：接口域名+接口地址

接入步骤：

使用appid和appkey调用身份认证接口, 获取access_token和refresh_token 使用access_token做为身份凭证调用数据业务接口获取业务数据
refresh_token用于刷新access_token的有效期

如何使用access_token？

access_token需要加在 HTTP 的头部 header中, 格式：
AUTHORIZATION: Bearer {access_token}
access_token的有效期为一小时, 过期需要重新刷新或获取。使用时需要注意空格和大小写

返回结果

字段	说明
code	状态码
info	状态信息
data	数据信息

身份认证接口状态码

状态码	状态信息	说明
1000	Success	调用成功
1001	Invalid Parameter	参数非法
1002	Invalid Appid Or Appkey	appid与appkey不匹配
1003	Appid Forbid	appid被禁用
1004	Invalid Appid Or Refresh Token!	app id与access_token不匹配
1005	Fail	系统内部错误
1006	Appid Expired	appid 已过期

数据业务类接口状态码

状态码	状态信息	说明
1000	Success	调用成功
1101	No Authority	未授权, appid或者appkey错误
1102	Has Expired	已过期, access_token 的有效期已过, 需重新刷新access_token
1103	Access Forbid	禁止访问, appid已禁用
1104	Invalid Scope	无效的接口
1105	Scope Forbid	未授权的接口, 可以联系运营人员开通这个接口
1106	Request Number Is 0!	使用次数已用完
1107	App counter decrease fail!	更新使用次数失败, 属于系统内部错误
1108	Write request history fail!	更新访问记录失败, 属于系统内部错误
1109	Data has been deleted	请求的接口已关闭
1110	The requested data does not exist	请求的数据不存在
1111	Too many requests	请求次数过于频繁（普通账号1800s/200次，存量调取可开通7天1s/次的调取时长）