小白接口

创建新数据接口

接口链接:http://api.okayapi.com/?s=App.Table.Create

功能说明: 在自定义数据模型中添加一个新数据,添加的字段应先在后台进行添加。

容易程度:

分类标签:免费  热门  验签

请求协议
HTTP/HTTPS
请求方式
GET/POST
编码格式
UTF-8
返回格式
JSON

在线调试    添加收藏    直接访问接口    评论(0    loading...

接口参数

参数名字类型是否必须默认值其他说明
sign字符串可选签名,如果不需要签名,可在小白后台进行签名设置
app_key字符串必须最小:32;最大:32应用ID。查看我的app_key
uuid字符串可选最小:32;最大:32需要绑定的UUID,全局唯一用户ID。如果有传递此参数,则数据将会与特定用户绑定;如果不传,则为全局数据。查看全部注册会员。
token字符串可选最小:64;最大:64会话凭证。如果有传递此参数,则进行用户身份校验,成功后数据将自动与用户绑定,需结合uuid参数一起使用。
model_name字符串必须模型名称(对应在小白开放平台创建时的数据库表名称),查看我的全部模型
check_code字符串可选最大:64待检测的口令,仅当在小白开放平台配置口令后才会对此参数进行检测,规则配置教程图解自定义模型规则.pdf
data数组必须创建时的初始化数据,需要JSON编码后传递。格式:data={"字段名1":"字段值1","字段名2":"字段值2"...},系统保留表字段(id, uuid, add_time, update_time, ext_data)将会被忽略。JSON在线解析及格式化验证

返回结果

返回字段类型说明
err_code整型状态操作码,0成功;1创建失败(不符合表字段要求,或表字段不存在);2应用层规则拦截,拦截后可以小白开放平台查看日记
err_msg字符串错误提示信息,err_code非0时参考此提示信息
id整型新创建数据的自增ID

简易在线调试

参数是否必填
service 必须
uuid 可选
token 可选
model_name 必须
check_code 可选
data 必须

客户端接入示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

请求:
/?s=App.Table.Create&model_name=article&data={"title":"123456"}&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "id": 4
    },
    "msg": ""
}
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 请求小白接口(第一个示例:从省份开始选择):
$rs = OkayApiClient::request('App.Table.Create',array('model_name'=>'telephone','data'=>json_encode(array("mobile"=>"13088886666","mobile_status"=>"1"))));

// 输出结果
print_r($rs);

/*
Array 
( 
	[ret] => 200 
	[data] => 
	Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[id] => 6 
	) 
	[msg] => 当前小白接口:App.Table.Create 
)
*/
#!/usr/bin/python
#coding=utf-8

import requests
import hashlib

# TODO: 请根据需要,换成您的HOST,app_key和app_secrect
API_URL     = '你的小白接口域名,例如:http://api.okayapi.com/'
APP_KEY     = '你的app_key'
APP_SECRET  = '你的app_secrect'

# 生成签名
def Signature(params, key=None, secret=None):
    key = key or APP_KEY
    secret = secret or APP_SECRET
    params.pop('app_secrect', None)
    params['app_key'] = key
    md5_ctx = hashlib.md5()
    md5_ctx.update(''.join([params[value] for value in sorted([key for key in params])]) + secret)
    return md5_ctx.hexdigest().upper()
    

# 请求小白接口
def HTTPGet(url, params):
    params['sign'] = Signature(params)
    resp = requests.get(url, params)
    return resp.json()


def main():
    # 待请求的接口与相关参数(根据需要,可动态调整请求参数)
    params = {
        's': 'App.Table.Create',
        'model_name': 'okayapi_message',
        'data': json.dumps({'message_nickname': 'test', 'message_key': 'aba'})
    }

    # 发起请求
    return HTTPGet(API_URL, params)


pprint.pprint(main())

# {u'data': {u'err_code': 0, u'err_msg': u'', u'id': u'6'},
#  u'msg': u'\u5f53\u524d\u5c0f\u767d\u63a5\u53e3\uff1aApp.Table.Create',
#  u'ret': 200}

异常情况

错误码错误描述信息解决方法
400非法请求,参数错误1、根据接口文档的接口参数,提供正确的参数
401用户未登录,或登录凭证已过期1、如果用户未注册,请先用注册接口;2、如果注册未登录或会话过期,请先用登录接口
404接口服务不存在1、查看小白接口大全,确保接口服务名称拼写正确
406权限不足,应用签名错误、或者应用已过期1、使用在线调试,校正签名;2、关闭特定或全部签名设置;3、如果过期,可以进行续约/升级
500小白接口内部系统错误,如果出现此错误,请联系技术人员处理1、进入QQ交流群660311764,反馈问题;2、或者提交工单,一天内回复

如何使用小白接口操作数据库?

评论(0

暂无评论~
// 获取评论