接口路径(新):http://api.yesapi.net/api/App/Hello/World
接口路径(旧):http://api.yesapi.net/?s=App.Hello.World
接口描述: 入门必备,最强接口欢迎您! 用于第一次接口接入,验证签名
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| name | 字符串 | 必须 | 随便一个名字参数 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 000 Hello Wolrd示例接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Hello.World`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 入门必备,最强接口欢迎您! 用于第一次接口接入,验证签名
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Hello.World` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: 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,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| name | string | 必填 | 随便一个名字参数 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
| data.title | string | 测试标题|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Hello.World&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```请求:
{你的接口域名}/?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表示服务端异常,查看异常错误码 |
| data | object/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+万次