开发指南

概述

开发人员在调用KuickDeal开放API之前,需要先通读本篇介绍,明白ClientID和ClientSecret的获取、Kuick用户如何注册、如何获取Kuick用户的AccessToken, AccessToken如何使用和调用API的返回格式和错误码格式。

ClientID和ClientSecret获取

ClientID和ClientSecret为第三方合作伙伴调用KuickDeal平台API的凭证信息,请发送
邮件到support@kuick.cn或者打电话4008766261获取。

Kuick用户注册

请求地址

POST https://deal-api.kuick.cn/kuickuser/oauth2/register

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
phoneNum string 手机号
password string 初始密码
channel string 注册来源, 3: 网站;4:网站开会页面; 5: ios; 6: android; 7: 第三方合作伙伴
nickname string 昵称
sex int 性别
city string 城市
province string 省份

注意:通过该方式注册的Kuick账号是没有激活的,需要用户登陆KuickDeal激活后才能正常使用。

参数名称 参数类别 是否必填 参数说明
email string 邮箱
password string 初始密码
channel string 注册来源, 3: 网站;4:网站开会页面; 5: ios; 6: android; 7: 第三方合作伙伴
nickname string 昵称
sex int 性别
city string 城市
province string 省份

注意:通过该方式注册的Kuick账号是没有激活的,需要用户登陆KuickDeal激活后才能正常使用。

正常返回结果

{
    "refresh_token": "ad11b3fc3c3c87e58e1f7664f977caca",
    "token_type" : "bearer",
    "access_token": "f9205ae4f6c17b68566a2f308594a42242d914c4d5cf171a58b64bcfc57b6a73f5752798377bd87d5363ebc98a8caa583afb5705984e428550de6412",
    "expires_in": 604800
}

正常返回结果说明

字段名称 字段类型 字段说明
refresh_token string 刷新令牌
token_type string 令牌类型
access_token string 访问令牌
expires_in long 令牌过期时间,单位s,默认新创建的AccessToken过期时间为7天

异常返回结果

http_status:400

{
    "error": "phone_num_existed",
    "error_description": "手机号已经存在"
}

异常返回结果说明

字段名称 字段类型 字段说明
error string 错误类型,code_not_correct:验证码不正确、phone_num_existed:手机号已经存在、email_existed:邮箱已经存在
error_description string 具体的错误描述

获取Kuick用户的AccessToken

请求地址

POST https://deal-api.kuick.cn/kuickuser/oauth2/access_token

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
grant_type string 授权类型:此次为 'password'
username string 用户名,支持手机号、邮箱
password string 密码

正常返回结果

{
    "expires_in": 604800,
    "access_token": "f9205ae4f6c17b68566a2f308594a42242d914c4d5cf171a58b64bcfc57b6a73f5752798377bd87d5363ebc98a8caa583afb5705984e428550de6412",
    "refresh_token": "ad11b3fc3c3c87e58e1f7664f977caca",
    "token_type" : "bearer"
}

正常返回结果说明

字段名称 字段类型 字段说明
expires_in long 令牌过期时间,单位s,默认新创建的AccessToken过期时间为7天
access_token string 访问令牌
refresh_token string 刷新令牌
token_type string 令牌类型

异常返回结果

http_status:400

{
    "error": "invalid_request",
    "error_description": "No authorization header passed"
}

异常返回结果说明

字段名称 字段类型 字段说明
error string 错误类型:invalid_client:不可用的客户端ID或者密码;invalid_grant:授权失败
error_description string 具体的错误描述

刷新AccessToken

请求地址

POST https://deal-api.kuick.cn/kuickuser/oauth2/access_token

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
grant_type string 授权类型:此次为 'refresh_token'
refresh_token string 刷新Token

正常返回结果

{
    "expires_in": 604800,
    "access_token": "f9205ae4f6c17b68566a2f308594a42242d914c4d5cf171a58b64bcfc57b6a73f5752798377bd87d5363ebc98a8caa583afb5705984e428550de6412",
    "token_type" : "bearer"
}

正常返回结果说明

字段名称 字段类型 字段说明
expires_in long 令牌过期时间,单位s,默认新创建的AccessToken过期时间为7天
access_token string 访问令牌
token_type string 令牌类型

异常返回结果

http_status:400

{
    "error": "invalid_request",
    "error_description": "No authorization header passed"
}

异常返回结果说明

字段名称 字段类型 字段说明
error string 错误类型:invalid_client:不可用的客户端ID或者密码;invalid_grant:授权失败
error_description string 具体的错误描述

根据AccessToken获取Kuick用户信息

请求地址

GET https://deal-api.kuick.cn/kuickuser/oauth2/getUserInfoByAccessToken

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
access_token string 访问令牌

正常返回结果

{
    "id": 6,
    "password": "xxx",
    "name": "xxx",
    "email": "xxx",
    "emailStatus": 1,
    "phoneNum": "xxxx",
    "phoneNumStatus": 1,
    "photoURI": "xxxx",
    "openid": null,
    "sex": 1,
    "city": "海淀",
    "province": "北京 海淀",
    "company": "哈哈",
    "unionid": null,
    "ccNum": 28125106,
    "status": 1,
    "position": "哈哈",
    "industry": "互联网",
    "channel": null,
    "weixinNickname": null,
    "salesCount": null,
    "personInfoStatus": 1,
    "createdAt": "2015-08-26 08:40:08",
    "updatedAt": "2017-06-14 18:40:40",
    "unionidStatus": 1
}

正常返回结果说明

字段名称 字段类型 字段说明
id int 用户id
password string 密码
name string 用户名
email string 用户邮箱
emailStatus int 用户邮箱验证状态 0:未验证、1:已验证
phoneNum string 用户手机号
phoneNumStatus int 用户手机号验证状态 0:未验证、1:已验证
photoURI string 用户头像
openid string 微信用户唯一标识
sex string 用户性别,1为男性,2为女性
city string 城市
province string 省份
company string 公司
ccNum int cc号:随机8位数字
unionid string 微信用户唯一标识
status int 用户状态,0:新注册、1:已激活、2:已停用
position string 职位
industry string 所属行业
channel string 注册来源, 3: 网站;4:网站开会页面; 5: ios; 6: android; 7: 第三方合作伙伴
weixinNickname string 微信昵称
salesCount int 销售人数
personInfoStatus int 用户信息完整状态,0:未完整,1:已完整
createdAt date 用户注册时间
updatedAt date 用户修改时间
unionidStatus int 微信unionid状态,1:有、0:无

API公共错误说明

HTTP错误码 返回样例 错误描述
403 {"error": "access_denied","error_description": "Bearer token not found"} error:access_denied:访问拒接;forbidden:禁止访问
404 一个404html报错页面 请求的URI不存在,请检查API的URI是否写错了

注:以上错误规则适用于除登陆API以外的所有API调用。

API公共认证头说明

为了保证API调用的安全性,平台所有需要认证的API调用都需要在请求头添加认证信息,形如:

`Authorization:Bearer ${access_token}`

其中的${access_token}替换为登陆成功后获取到的访问令牌环。

API返回结果说明

如果API调用返回20x,则:

正常返回的报文为:

{
    "status": 1,
    "data": {
        业务对象
    }
}
字段名称 字段类型 字段说明
status int 状态码,1表示正常
data JSON 业务结果

异常返回的报文为:

{
    "status": 0,
    "code": "app_not_found"
    "msg": "项目不存在"
}
字段名称 字段类型 字段说明
status int 状态码,1表示正常
code string 错误码,每个API不一样
msg string 错误描述
北京西会科技有限公司©2015-2018 all right reserved,powered by Gitbook该文件修订时间: 2018-11-21 01:53:15

results matching ""

    No results matching ""