OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
member_id | String | Optaion | 会员ID,可以使用小白开放平台的会员体系(即传递uuid+token),或者使用第三方平台的会员体系(即需要自定义指定member_id),这两者应提供至少其中一种,以免无法与会员对应关联。若uuid和member_id均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:
|
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
member_id | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,1表示失败,9表示插件未安装 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
address | Object | 默认收货地址的详情信息,没有时为null |
address.id | Int | 收货地址ID |
address.uuid | String | 小白会员UUID |
address.add_time | String | 添加时间,如:2019-10-14 16:18:58 |
address.update_time | String | 更新时间,如:2019-10-14 17:07:21 |
address.ext_data | Object | 扩展数据,没有时为null |
address.member_id | Int | 第三方用户id,没有时为0 |
address.provinces | Int | 省id,没有时为0 |
address.city | Int | 市id,没有时为0 |
address.area | Int | 区id,没有时为0 |
address.address_name | String | 地址别名 |
address.address_details | String | 详细地址 |
address.is_default | Int | 是否默认地址,1是0不是 |
address.zip_code | String | 邮编 |
address.realname | String | 真实姓名 |
address.home_phone | String | 家庭号码 |
address.mobile | String | 手机号码 |
address.email | String | 邮箱 |
address.provinces_name | String | 省份名,没有时为空字符串 |
address.city_name | String | 城市名,没有时为空字符串 |
address.area_name | String | 区县名,没有时为空字符串 |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | Illegal-Params |
Http Status = 401 | Illegal-Token |
Http Status = 402 | IP-Banned |
Http Status = 404 | API-NOT-Exsits |
Http Status = 406 | Illegal-APPKEY |
Http Status = 407 | APPKEY-Expired-Out |
Http Status = 408 | APPKEY-Busy |
Http Status = 409 | Illegal-Sign |
Http Status = 413 | API-Traffic-NOT-Enough |
Http Status = 415 | API-LOCKED |
Http Status = 500 | Internal-Server-Error |