智简魔方文档

创建API密钥

方法概览

项目内容
文档类型PHP 类方法
方法标识app\common\model\ApiModel::createApi
所属业务开放接口
来源模块/系统API密钥模型

功能说明

创建API密钥

调用示例

$param = ['name' => '示例名称'];
$result = (new \app\common\model\ApiModel())->createApi($param);

参数

参数类型必填默认值校验规则说明
param.namestringrequired名称

返回值

返回项类型说明
statusint状态码,200成功,400失败
msgstring提示信息
data.apiobjectAPI密钥
data.api.nameintAPI密钥名称
data.api.idintAPI密钥ID
data.api.tokenstringtoken
data.api.create_timeint创建时间
data.api_urlstringAPI接口地址

正常返回

{
  "status": 1,
  "msg": "string",
  "data": {
    "api": {
      "name": 1,
      "id": 1,
      "token": "example-token",
      "create_time": 1752984000
    },
    "api_url": "https://example.com/callback"
  }
}

异常情况

异常类型说明
Throwable调用失败时由具体实现抛出异常,异常信息以运行时结果为准。