• 小白接口
  • 我的API
    • MyAPI(接口DIY,中文接口编程)
    • 私人定制API(由平台开发)
    • API在线测试
    • 免费创建我的接口
  • 应用API
    • 会员模块 重要
    • 配置模块
    • 数据统计模块 剩余流量
    • 日志模块
    • CDN图片文件模块
    • 邮件服务模块
    • 图形验证码模块
    • 微信集成模块
    • 短链接模块
  • 数据库API
    • 表单数据接口 [通用版] 开发必备
    • 表单结构API
    • 程序化数据API
    • MySQL/PostgreSQL API [直连版]
    • Sql Server API [数据库配置]
    • Sql Server API [存储过程]
    • Sql Server API [数据库操作]
  • 常用API
    • 二维码模块
    • 条形码模块
    • 会员头像模块
    • IP服务模块
    • 拼音模块
    • 昵称API
    • 密码API
    • 模拟数据API
    • 日期API
    • 唯一ID生成API
    • 快递API
    • 加解密API
    • JWT认证授权API
    • 中文分词API
    • 简繁体转换API
  • 教程
  • API开发
    • 接口源码库 推荐
    • 接口DIY (低代码开发)
    • AI写接口
  • 登录
  • 注册



YesApi 接口文档

000 Hello Wolrd示例接口

接口路径(新):http://api.yesapi.net/api/App/Hello/World

接口路径(旧):http://api.yesapi.net/?s=App.Hello.World

接口描述: 入门必备,最强接口欢迎您! 用于第一次接口接入,验证签名

接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数接口签名,其中:
  • 使用动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包,通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名,点击获取我的静态签名
  • 关闭签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构,其中:
  • return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};
  • return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。
name字符串必须随便一个名字参数

客户端请求示例

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

HTTP通用示例PHP示例Python示例微信小程序示例
请求:
{你的接口域名}/?s=App.Hello.World&name=OKAYAPI&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "title": "Hello OKAYAPI!"
    },
    "msg": ""
}
<?php
// 引入PHP SDK文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口(根据需要,可动态调整请求参数)
$rs = OkayApiClient::request('App.Hello.World', array('name' => 'dogstar'), 3000);

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

/**
Array
(
    [ret] => 200
    [data] => Array
    (
        [err_code] => 0
        [err_msg] => 
        [title] => Hi dogstar,欢迎使用小白接口!
    )

    [msg] => 小白开放接口:App.Hello.World
)
 */
#!/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.Hello.World', 'name': 'dogstar'}

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

print(main())

# {u'msg': u'\u5f53\u524d\u5c0f\u767d\u63a5\u53e3\uff1aApp.Hello.World', u'data': {u'title': u'Hi dogstar\uff0c\u6b22\u8fce\u4f7f\u7528\u5c0f\u767d\u63a5\u53e3\uff01', u'err_msg': u'', u'err_code': 0}, u'ret': 200}


import yesapi from '../../utils/YesApi/yesapi.js';


  /**
   * 小白接口请求示例
   */
  okayApiHelloWorld: function(e) {
    /**
     * 准备接口参数(根据需要,可动态调整请求参数)
     */
    let params = {
      s: "Hello.World", 		// 必须,待请求的接口服务名称
      name: "dogstar" 		  // 可选,根据接口文档,补充更多接口参数
    };
    let _self = this

    /**
     * 对小白接口发起请求
     */
    wx.request({
      url: app.globalData.okayapiHost,    // 使用小白接口的域名,或者PHP代理域名
      data: okayapi.enryptData(params),   // 如果直接调用小白接口,需要在小程序里生成签名
      method: "POST",                     // 通常情况下都可使用POST方式调用小白开放接口
      header: { "Content-Type": "application/x-www-form-urlencoded" }, // 大坑:如果使用的是POST请求,一定要设置这个header,不然参数无法POST
      success: function (wxRes) {
        // TODO:实现你的梦想……
        let res = wxRes.data

        if (res.data && res.data.err_code == 0) {
          // TODO:请求成功
          console.log('ok: ', res.data)

        } else {
          // TODO:当前操作失败
          console.log('fail: ', res)

        }

      }
    })  
  }


JS SDK 下载:https://github.com/yesapicn/yesapi-wxmini-sdk

接口返回及数据结构

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.err_code整型操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
data.title字符串测试标题
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

由 果创云YesApi.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次