创建API密钥
方法概览
| 项目 | 内容 |
|---|---|
| 文档类型 | PHP 类方法 |
| 方法标识 | app\common\model\ApiModel::createApi |
| 所属业务 | 开放接口 |
| 来源模块/系统 | API密钥模型 |
功能说明
创建API密钥
调用示例
$param = ['name' => '示例名称'];
$result = (new \app\common\model\ApiModel())->createApi($param);参数
| 参数 | 类型 | 必填 | 默认值 | 校验规则 | 说明 |
|---|---|---|---|---|---|
param.name | string | 是 | — | required | 名称 |
返回值
| 返回项 | 类型 | 说明 |
|---|---|---|
status | int | 状态码,200成功,400失败 |
msg | string | 提示信息 |
data.api | object | API密钥 |
data.api.name | int | API密钥名称 |
data.api.id | int | API密钥ID |
data.api.token | string | token |
data.api.create_time | int | 创建时间 |
data.api_url | string | API接口地址 |
正常返回
{
"status": 1,
"msg": "string",
"data": {
"api": {
"name": 1,
"id": 1,
"token": "example-token",
"create_time": 1752984000
},
"api_url": "https://example.com/callback"
}
}异常情况
| 异常类型 | 说明 |
|---|---|
Throwable | 调用失败时由具体实现抛出异常,异常信息以运行时结果为准。 |