接口约定
调用方式:接口调用方式采用http调用方式,使用REST API模式。
参数编码:参数值部分采用UTF-8编码。
公共参数:所有的接口方法调用都必须加上token参数,token参数须向房价网申请。
响应方式:接口返回的数据格式为JSON格式。
授权
在访问房价网开放API前必须向房价网申请token。
接口地址:http://open.fangjia.com/accessToken
请求参数:
参数名 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
username | String | 是 | 用户名 |
password | String | 是 | 密码 |
appKey | String | 是 | appKey |
响应参数:
名称 | 类型 | 描述 |
---|---|---|
token | String | token有效期为2小时 |
JSON返回示例:
错误码参照
返回码说明:
返回码 | 说明 |
---|---|
200 | 正确 |
400 | 请求参数错误,详情可以看msg |
401 | 未经授权,通常是进行了不被授权的操作 |
500 | 服务器内部错误 |
msg说明:
200类:正常返回
400类:此类错误原因是请求格式不正确,msg描述参数错误的具体原因,如:“城市名为必填项”
401类:此类错误原因是授权验证出错,msg提示如下:
1. 没有权限访问对应的资源(认证失败)
2. 没有权限访问对应的资源(你的账户已失效)
3. 没有权限访问对应的资源(您未开通城市上海的权限)(该处只是示例,会根据城市不同做相应提示)
4. 没有权限访问对应的资源(已达到配额上限)
500类:msg为“服务器内部错误” ,此时应该是我们遇到bug了,您可以联系我们