OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
db_mark | String | Required | 直连数据库代号,注意!这是开发者添加的数据库代号,不是数据库的名称。使用API前请先添加新数据库连接配置。 | ||
proc_name | String | Required | MIN: 1 | 存储过程的名称,对应create proc [过程名称]。 | |
pro_params | ArrayJSON Format | Optaion | [] | 存储过程的参数,没有时可不传。JSON格式,key对应参数名称,参数名称不需要在前面加@符号,注意参数类型(支持:字符串/整型/浮点型/NULL),只支持一级参数。例如:{"name":"YesApi","quantity":666,"parent_id":null} |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
db_mark | *Required | |
proc_name | *Required | |
pro_params | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作状态码,0成功,1失败 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
affected_rows | Int | 正常时,返回影响的行数。失败时返回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 |