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均未提供,则不关联会员;若两者都提供,则两者都会进行同时匹配关联。即分为以下四种情况:
| ||
| address_name | String | Optaion | MAX: 200 | 地址别名,例如:家里、公司、学校、父母家 | |
| address_details | String | Optaion | MAX: 1000 | 详细地址,完整的详细地址 | |
| provinces | Int | Optaion | 0 | 省份id,可以参考使用App.Common_Address.Choose接口的省份编码 | |
| city | Int | Optaion | 0 | 城市id,可以参考使用App.Common_Address.Choose接口的城市编码 | |
| area | Int | Optaion | 0 | 区县id,可以参考使用App.Common_Address.Choose接口的区县编码 | |
| zip_code | String | Optaion | MAX: 10 | 邮编 | |
| realname | String | Optaion | MAX: 100 | 真实姓名 | |
| mobile | String | Optaion | MAX: 20 | 手机号码,例如:13800138000 | |
| home_phone | String | Optaion | MAX: 20 | 家庭号码,例如:020-88888888 | |
| String | Optaion | MAX: 100 | 邮箱地址,例如:xxx@yesapi.cn |
API Debug
| KEY | REQUIRED | VALUE |
|---|---|---|
| app_key | *Required | |
| member_id | Option | |
| address_name | Option | |
| address_details | Option | |
| provinces | Option | |
| city | Option | |
| area | Option | |
| zip_code | Option | |
| realname | Option | |
| mobile | Option | |
| home_phone | Option | |
| Option |
API Response
| KEY | Type | Description |
|---|---|---|
| err_code | Int | 操作码,0表示成功(每个会员最多设置20个收货地址),1表示失败,9表示插件未安装 |
| err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
| id | Int | 新地址ID,失败时返回0 |
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 |