• OkayAPI Docs
  • Login
  • Try for free



YesApi 接口文档

301 添加配置

接口路径(新):http://api.okayapi.com/api/App/Config/AddConfig

接口路径(旧):http://api.okayapi.com/?s=App.Config.AddConfig

接口描述: 添加一份新配置

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
config_nameStringRequired配置名称,如:config_switch
config_valueStringRequired待添加的配置值,可以是数字、字符串、文本等

API Usage Demo

HTTP
请求:
{OKAYAPI_API_HOST}/?s=App.Config.AddConfig&config_name=config_year&config_value=2019&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "V1.4.1 小白开放接口 App.Config.AddConfig"
}

API Response

KEYTypeDescription
err_codeInt操作码,0添加配置成功,1配置已存在,不能重复添加
err_msgString错误提示信息,err_code非0时参考此提示信息

YesApi 接口文档

302 获取配置

接口路径(新):http://api.okayapi.com/api/App/Config/GetConfig

接口路径(旧):http://api.okayapi.com/?s=App.Config.GetConfig

接口描述: 获取已经存在的配置

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
config_nameStringRequired配置名称,如:config_switch

API Usage Demo

HTTP
请求:
{OKAYAPI_API_HOST}/?s=App.Config.GetConfig&config_name=config_year&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "config_value": "2019"
    },
    "msg": "V1.4.1 小白开放接口 App.Config.GetConfig"
}

API Response

KEYTypeDescription
err_codeInt操作码,0获取配置成功,2配置已存在
err_msgString错误提示信息,err_code非0时参考此提示信息
config_valueString配置值,不存在时返回null

YesApi 接口文档

303 修改配置

接口路径(新):http://api.okayapi.com/api/App/Config/EditConfig

接口路径(旧):http://api.okayapi.com/?s=App.Config.EditConfig

接口描述: 以最新的配置覆盖原来的配置。

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
config_nameStringRequired配置名称,如:config_switch
config_valueStringRequired待更新的配置值,可以是数字、字符串、文本等

API Usage Demo

HTTP
请求:
{OKAYAPI_API_HOST}/?s=App.Config.EditConfig&config_name=config_year&config_value=2020&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "V1.4.1 小白开放接口 App.Config.EditConfig"
}

API Response

KEYTypeDescription
err_codeInt操作码,0获取配置成功,1配置不存在
err_msgString错误提示信息,err_code非0时参考此提示信息

YesApi 接口文档

304 删除配置

接口路径(新):http://api.okayapi.com/api/App/Config/RemoveConfig

接口路径(旧):http://api.okayapi.com/?s=App.Config.RemoveConfig

接口描述: 删除一份配置

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
config_nameStringRequired配置名称,如:config_switch

API Usage Demo

HTTP
请求:
{OKAYAPI_API_HOST}/?s=App.Config.RemoveConfig&config_name=config_year&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "V1.4.1 小白开放接口 App.Config.RemoveConfig"
}

API Response

KEYTypeDescription
err_codeInt操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
err_msgString错误提示信息,err_code非0时参考此提示信息

Power by OkayAPI.com Contact us (WA: okayapi OR Email: chanzonghuang@gmail.com).
Timezone: America/New_York May/10/2025 07:02:40