接口路径(新):http://api.yesapi.net/api/App/Common_Date/GetDaysFromNow
接口路径(旧):http://api.yesapi.net/?s=App.Common_Date.GetDaysFromNow
接口描述: 根据输入的日期返回一个整数
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| yearStart | 整型 | 可选 | 2016 | 起始年份,默认2016,值 0-69 会映射为 2000-2069,值 70-100 会映射为 1970-2000起始年份 不是整型的数会转成0 | |
| monthStart | 整型 | 可选 | 2 | 起始月份,默认2,值 0-12 | |
| dayStart | 整型 | 可选 | 9 | 起始天数,默认9,值 0-31 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 3401 查看输入日期至今一共多少天】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Common_Date.GetDaysFromNow`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 根据输入的日期返回一个整数
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Common_Date.GetDaysFromNow` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| yearStart | int | 可选 | 起始年份,默认2016,值 0-69 会映射为 2000-2069,值 70-100 会映射为 1970-2000起始年份 不是整型的数会转成0 |
| monthStart | int | 可选 | 起始月份,默认2,值 0-12 |
| dayStart | int | 可选 | 起始天数,默认9,值 0-31 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.yearStart | int | 起始年份,默认2016,值 1-69 会映射为 2001-2069,值 70-100 会映射为 1970-2000 不是整型的数会转成0|
| data.monthStart | int | 起始月份,默认2,值 1-12 不是整型的数会转成0|
| data.dayStart | int | 起始日期,默认9,值 1-31 不是整型的数会转成0|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Common_Date.GetDaysFromNow&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.Common_Date.getDaysFromNow&yearStart=2016&monthStart=2&dayStart=9
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"diff": "1127"
},
"msg": "小白开放接口:App.Common_Date.getDaysFromNow"
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$yearStart = 2016;
$monthStart = 2;
$dayStart = 9;
$rs = OkayApiClient::request('App.Common_Date.GetDaysFromNow', array('yearStart' => $yearStart,'monthStart' => $monthStart,'dayStart' => $dayStart));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[diff] => 1127
)
[msg] => 小白开放接口:App.Common_Date.GetDaysFromNow
)
*/| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.yearStart | 整型 | 起始年份,默认2016,值 1-69 会映射为 2001-2069,值 70-100 会映射为 1970-2000 不是整型的数会转成0 |
| data.monthStart | 整型 | 起始月份,默认2,值 1-12 不是整型的数会转成0 |
| data.dayStart | 整型 | 起始日期,默认9,值 1-31 不是整型的数会转成0 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Common_Date/GetDaysDiff
接口路径(旧):http://api.yesapi.net/?s=App.Common_Date.GetDaysDiff
接口描述: 根据输入的两日期差返回一个整数
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| yearStart | 整型 | 必须 | 起始年份,值 0-69 会映射为 2000-2069,值 70-100 会映射为 1970-2000 | ||
| monthStart | 整型 | 必须 | 起始月份,值 0-12 | ||
| dayStart | 整型 | 必须 | 起始天数,值 0-31 | ||
| yearEnd | 整型 | 必须 | 结束年份,值 0-69 会映射为 2000-2069,值 70-100 会映射为 1970-2000 | ||
| monthEnd | 整型 | 必须 | 结束月份,值 0-12 | ||
| dayEnd | 整型 | 必须 | 结束天数,可选,值 0-31 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 3402 查看两日期之间一共间隔多少天】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Common_Date.GetDaysDiff`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 根据输入的两日期差返回一个整数
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Common_Date.GetDaysDiff` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| yearStart | int | 必填 | 起始年份,值 0-69 会映射为 2000-2069,值 70-100 会映射为 1970-2000 |
| monthStart | int | 必填 | 起始月份,值 0-12 |
| dayStart | int | 必填 | 起始天数,值 0-31 |
| yearEnd | int | 必填 | 结束年份,值 0-69 会映射为 2000-2069,值 70-100 会映射为 1970-2000 |
| monthEnd | int | 必填 | 结束月份,值 0-12 |
| dayEnd | int | 必填 | 结束天数,可选,值 0-31 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.yearStart | int | 起始年份,值 1-69 会映射为 2001-2069,值 70-100 会映射为 1970-2000 不是整型的数会转成0|
| data.monthStart | int | 起始月份,值 1-12 不是整型的数会转成0|
| data.dayStart | int | 起始日期,值 1-31 不是整型的数会转成0|
| data.yearEnd | int | 结束年份,值 1-69 会映射为 2001-2069,值 70-100 会映射为 1970-2000 不是整型的数会转成0|
| data.monthEnd | int | 结束月份,值 1-12 不是整型的数会转成0|
| data.dayEnd | int | 结束日期,值 1-31 不是整型的数会转成0|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Common_Date.GetDaysDiff&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.Common_Date.getDaysDiff&yearStart=2016&monthStart=2&dayStart=9&yearEnd=2019&monthEnd=3&dayEnd=12&app_key={你的app_key}&sign={接口签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"diff": "1127"
},
"msg": "小白开放接口:App.Common_Date.getDaysDiff"
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$yearStart = 2016;
$monthStart = 2;
$dayStart = 9;
$yearEnd = 2019;
$monthEnd = 3;
$dayEnd = 12;
$rs = OkayApiClient::request('App.Common_Date.GetDaysFromNow', array('yearStart' => $yearStart,'monthStart' => $monthStart,'dayStart' => $dayStart,'yearEnd' => $yearEnd,'monthEnd' => $monthEnd,'dayEnd' => $dayEnd));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[diff] => 1127
)
[msg] => 小白开放接口:App.Common_Date.GetDaysDiff
)
*/| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.yearStart | 整型 | 起始年份,值 1-69 会映射为 2001-2069,值 70-100 会映射为 1970-2000 不是整型的数会转成0 |
| data.monthStart | 整型 | 起始月份,值 1-12 不是整型的数会转成0 |
| data.dayStart | 整型 | 起始日期,值 1-31 不是整型的数会转成0 |
| data.yearEnd | 整型 | 结束年份,值 1-69 会映射为 2001-2069,值 70-100 会映射为 1970-2000 不是整型的数会转成0 |
| data.monthEnd | 整型 | 结束月份,值 1-12 不是整型的数会转成0 |
| data.dayEnd | 整型 | 结束日期,值 1-31 不是整型的数会转成0 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Common_Date/ChangeIntoLunar
接口路径(旧):http://api.yesapi.net/?s=App.Common_Date.ChangeIntoLunar
接口描述: 根据输入的日期返回农历日期如2019-3-12->二月初六
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| yearStart | 整型 | 可选 | 2016 | 阳历年份,默认2016,值 0-69 会映射为 2000-2069,值 70-100 会映射为 1970-2000 | |
| monthStart | 整型 | 可选 | 2 | 阳历月份,默认2,值 0-12 | |
| dayStart | 整型 | 可选 | 9 | 阳历天数,默认9,值 0-31 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 3403 根据输入阳历日期转化成字符型农历日期】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Common_Date.ChangeIntoLunar`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 根据输入的日期返回农历日期如2019-3-12->二月初六
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Common_Date.ChangeIntoLunar` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| yearStart | int | 可选 | 阳历年份,默认2016,值 0-69 会映射为 2000-2069,值 70-100 会映射为 1970-2000 |
| monthStart | int | 可选 | 阳历月份,默认2,值 0-12 |
| dayStart | int | 可选 | 阳历天数,默认9,值 0-31 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.yearStart | int | 起始年份,默认2016,值 1-69 会映射为 2001-2069,值 70-100 会映射为 1970-2000 不是整型的数会转成0|
| data.monthStart | int | 起始月份,默认2,值 1-12 不是整型的数会转成0|
| data.dayStart | int | 起始日期,默认9,值 1-31 不是整型的数会转成0|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Common_Date.ChangeIntoLunar&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.Common_Date.ChangeIntoLunar&yearStart=2016&monthStart=2&dayStart=9&app_key={你的app_key}&sign={接口签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"lunarDate": "正月初二"
},
"msg": "小白开放接口:App.Common_Date.ChangeIntoLunar"
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$yearStart = 2016;
$monthStart = 2;
$dayStart = 9;
$rs = OkayApiClient::request('App.Common_Date.ChangeIntoLunar', array('yearStart' => $yearStart,'monthStart' => $monthStart,'dayStart' => $dayStart));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[lunarDate] => "正月初二"
)
[msg] => 小白开放接口:App.Common_Date.ChangeIntoLunar
)
*/| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.yearStart | 整型 | 起始年份,默认2016,值 1-69 会映射为 2001-2069,值 70-100 会映射为 1970-2000 不是整型的数会转成0 |
| data.monthStart | 整型 | 起始月份,默认2,值 1-12 不是整型的数会转成0 |
| data.dayStart | 整型 | 起始日期,默认9,值 1-31 不是整型的数会转成0 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Common_Date/ChangeIntoNation
接口路径(旧):http://api.yesapi.net/?s=App.Common_Date.ChangeIntoNation
接口描述: 根据输入的日期返回阳历日期如2019-1-1->2019-2-5(现只支持到2031年)
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| yearStart | 整型 | 可选 | 2016 | 阳历年份,默认2016,值 0-69 会映射为 2000-2069,值 70-100 会映射为 1970-2000 | |
| monthStart | 整型 | 可选 | 2 | 阳历月份,默认2,值 0-12 | |
| dayStart | 整型 | 可选 | 9 | 阳历天数,默认9,值 0-31 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 3404 根据输入农历日期转化成阳历日期】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Common_Date.ChangeIntoNation`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 根据输入的日期返回阳历日期如2019-1-1->2019-2-5(现只支持到2031年)
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Common_Date.ChangeIntoNation` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| yearStart | int | 可选 | 阳历年份,默认2016,值 0-69 会映射为 2000-2069,值 70-100 会映射为 1970-2000 |
| monthStart | int | 可选 | 阳历月份,默认2,值 0-12 |
| dayStart | int | 可选 | 阳历天数,默认9,值 0-31 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.yearStart | int | 起始年份,默认2016,值 1-69 会映射为 2001-2069,值 70-100 会映射为 1970-2000 不是整型的数会转成0|
| data.monthStart | int | 起始月份,默认2,值 1-12 不是整型的数会转成0|
| data.dayStart | int | 起始日期,默认9,值 1-31 不是整型的数会转成0|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Common_Date.ChangeIntoNation&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参数错误"
}
```| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.yearStart | 整型 | 起始年份,默认2016,值 1-69 会映射为 2001-2069,值 70-100 会映射为 1970-2000 不是整型的数会转成0 |
| data.monthStart | 整型 | 起始月份,默认2,值 1-12 不是整型的数会转成0 |
| data.dayStart | 整型 | 起始日期,默认9,值 1-31 不是整型的数会转成0 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Common_Date/Curtime
接口路径(旧):http://api.yesapi.net/?s=App.Common_Date.Curtime
接口描述: 获取时间,日期、年份、星期等
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| timestamp | 整型 | 可选 | 0 | 最小:0 | 当前时间戳,未指定时使用当前系统时间。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 3405 获取当前时间】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Common_Date.Curtime`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 获取时间,日期、年份、星期等
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Common_Date.Curtime` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| timestamp | int | 可选 | 当前时间戳,未指定时使用当前系统时间。 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.timestamp | int | 时间戳,例如:1564622918|
| data.datetime | string | 日期时间,例如:2019-08-01 00:00:00|
| data.date | string | 日期,例如:2019-08-01|
| data.date_md_zh | string | 中文日期,月份和天前面有0,例如:2019年08月01日|
| data.date_Nj_zh | string | 中文日期,月份和天前面没有0,例如:2019年8月1日|
| data.time_H | string | 时间,24 小时格式,例如:18:00:00|
| data.time_h | string | 时间,12 小时格式,例如:06:00:00|
| data.day_d | string | 日,月份中的第几天,有前导零的 2 位数字,01 到 31|
| data.day_j | string | 日,月份中的第几天,没有前导零,1 到 31|
| data.day_N | string | 日,星期中的第几天,1(表示星期一)到 7(表示星期天)|
| data.day_N_zh | string | 日,星期一到星期天|
| data.day_z | string | 日,年份中的第几天,0 到 365|
| data.week_W | string | 星期,年份中的第几周,每周从星期一开始,例如:42(当年的第 42 周)|
| data.month_m | string | 月,数字表示的月份,有前导零,01 到 12|
| data.month_n | string | 月,数字表示的月份,没有前导零,1 到 12|
| data.month_n_zh | string | 月,一月到十二月|
| data.year_Y | string | 年,4 位数字完整表示的年份,例如:1999 或 2003|
| data.hour_g | string | 小时,12 小时格式,没有前导零,1 到 12|
| data.hour_G | string | 小时,24 小时格式,没有前导零,0 到 23|
| data.hour_h | string | 小时,12 小时格式,有前导零,01 到 12|
| data.hour_H | string | 小时,24 小时格式,有前导零,00 到 23|
| data.minute_i | string | 分钟,有前导零的分钟数,00 到 59|
| data.second_s | string | 秒数,有前导零,00 到 59|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Common_Date.Curtime&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参数错误"
}
```| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.timestamp | 整型 | 时间戳,例如:1564622918 |
| data.datetime | 字符串 | 日期时间,例如:2019-08-01 00:00:00 |
| data.date | 字符串 | 日期,例如:2019-08-01 |
| data.date_md_zh | 字符串 | 中文日期,月份和天前面有0,例如:2019年08月01日 |
| data.date_Nj_zh | 字符串 | 中文日期,月份和天前面没有0,例如:2019年8月1日 |
| data.time_H | 字符串 | 时间,24 小时格式,例如:18:00:00 |
| data.time_h | 字符串 | 时间,12 小时格式,例如:06:00:00 |
| data.day_d | 字符串 | 日,月份中的第几天,有前导零的 2 位数字,01 到 31 |
| data.day_j | 字符串 | 日,月份中的第几天,没有前导零,1 到 31 |
| data.day_N | 字符串 | 日,星期中的第几天,1(表示星期一)到 7(表示星期天) |
| data.day_N_zh | 字符串 | 日,星期一到星期天 |
| data.day_z | 字符串 | 日,年份中的第几天,0 到 365 |
| data.week_W | 字符串 | 星期,年份中的第几周,每周从星期一开始,例如:42(当年的第 42 周) |
| data.month_m | 字符串 | 月,数字表示的月份,有前导零,01 到 12 |
| data.month_n | 字符串 | 月,数字表示的月份,没有前导零,1 到 12 |
| data.month_n_zh | 字符串 | 月,一月到十二月 |
| data.year_Y | 字符串 | 年,4 位数字完整表示的年份,例如:1999 或 2003 |
| data.hour_g | 字符串 | 小时,12 小时格式,没有前导零,1 到 12 |
| data.hour_G | 字符串 | 小时,24 小时格式,没有前导零,0 到 23 |
| data.hour_h | 字符串 | 小时,12 小时格式,有前导零,01 到 12 |
| data.hour_H | 字符串 | 小时,24 小时格式,有前导零,00 到 23 |
| data.minute_i | 字符串 | 分钟,有前导零的分钟数,00 到 59 |
| data.second_s | 字符串 | 秒数,有前导零,00 到 59 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Common_Date/GetSolarTerms
接口路径(旧):http://api.yesapi.net/?s=App.Common_Date.GetSolarTerms
接口描述: 输入年份获取 上一年冬至 ~ 下一年冬至
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| year | 整型 | 必须 | 0 | 年 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 3406 获取该年的所有节气】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Common_Date.GetSolarTerms`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 输入年份获取 上一年冬至 ~ 下一年冬至
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Common_Date.GetSolarTerms` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| year | int | 必填 | 年 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.年 | data.list.Y | |
| data.月 | data.list.M | |
| data.日 | data.list.D | |
| data.节气名字 | data.list.solarTermsName | |
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Common_Date.GetSolarTerms&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参数错误"
}
```| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.年 | data.list.Y | |
| data.月 | data.list.M | |
| data.日 | data.list.D | |
| data.节气名字 | data.list.solarTermsName | |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://api.yesapi.net/api/App/Common_Date/GetSolarTermsStarByDay
接口路径(旧):http://api.yesapi.net/?s=App.Common_Date.GetSolarTermsStarByDay
接口描述: 输入年 year 月 month 日 day 输出对应的节气和星座
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| year | 整型 | 必须 | 0 | 年 | |
| month | 整型 | 必须 | 1 | 最小:1;最大:12 | 月 |
| day | 整型 | 必须 | 1 | 最小:1;最大:31 | 日 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 3407 获取该天的 节气和星座】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Common_Date.GetSolarTermsStarByDay`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 输入年 year 月 month 日 day 输出对应的节气和星座
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Common_Date.GetSolarTermsStarByDay` |
| 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传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| year | int | 必填 | 年 |
| month | int | 必填 | 月 |
| day | int | 必填 | 日 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.星座 | data.solarTerms.D | |
| data.节气名字 | data.solarTermsName | |
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Common_Date.GetSolarTermsStarByDay&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参数错误"
}
```| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.星座 | data.solarTerms.D | |
| data.节气名字 | data.solarTermsName | |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
由 果创云YesApi.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次