API鉴权登录
方法概览
| 项目 | 内容 |
|---|---|
| 文档类型 | PHP 函数 |
| 方法标识 | /api/v1/auth |
| 所属业务 | 开放接口 |
| 来源模块/系统 | 用户模型 |
功能说明
API鉴权登录
调用示例
$username = '示例名称';
$password = 'Example@123';
$result = (new \app\common\model\ClientModel())->apiAuth($username, $password);参数
| 参数 | 类型 | 必填 | 默认值 | 校验规则 | 说明 |
|---|---|---|---|---|---|
username | string | 否 | — | — | 用户名(用户注册时的邮箱或手机号) |
password | string | 否 | — | — | 密码(api信息的token) |
返回值
| 返回项 | 类型 | 说明 |
|---|---|---|
data.jwt | string | 登录标识 |
正常返回
{
"data": {
"jwt": "string"
}
}异常情况
| 异常类型 | 说明 |
|---|---|
Throwable | 调用失败时由具体实现抛出异常，异常信息以运行时结果为准。 |