goodwe-logo开放平台
文档官网

登录接口

接口描述

功能描述

  • 登录接口，获取数据前必须调用此接口获取 TOKEN，TOKEN 过期时间为 4 小时。
  • 如果 TOKEN 未过期，则可重复使用；如果 TOKEN 已过期，则需再次调用登录接口获取新的 TOKEN。
  • 调用此接口登录成功后，响应头里会返回 TOKEN。

访问限制

每个ip的限流次数：每分钟10次。

请求方式

HTTPS调用

POST https://we.goodwe.com/api/openapi/v1/common/login

请求参数

属性类型必填说明
grantTypeString是鉴权模式（默认 client_credentials）
appIdString是客户端 id（通过注册固德威授权服务获得）
appSecretString是客户端私钥（通过注册固德威授权服务获得）

返回参数

属性类型说明备注
codeString请求成功或失败标识，“00000”请求成功，其余code请求失败-
descriptionString请求结果描述-
dataObject返回数据-
data.accessTokenString其余接口使用该 token 请求数据其余接口使用该token请求数据

其他说明

调用此接口登录成功后响应头里会返回 TOKEN，此参数需保留，在后续的数据接 口请求中，必须将该参数和值放入请求头中一起传给管理系统。

login

调用示例

请求数据示例

json
{
  "grantType": "client_credentials",
  "appId": "appId123456",
  "appSecret": "appSecret123456"
}

返回数据示例

样例1：登录成功

json
{
  "code": "00000",
  "description": "成功",
  "data": {
    "accessToken": "1333a62e-d3d8-49a4-9edc-2a50fc3c0a11",
    "tokenType": "bearer",
    "expiresIn": "12507",
    "scope": "tenantId:1450742399304253441",
    "tenantInfo": {
      "id": "1450742399304253441",
      "name": "某某租户",
      "enable": true,
      "activate": true,
      "customerCode": "SMH",
      "creatorId": "1436240154054823938",
      "createTime": "2021-10-20 08:35:16",
      "updateTime": "2024-03-13 16:20:02",
      "fromSupport": false,
      "tenantManager": false
    }
  }
}

样例2：登录失败

json
{
  "code": "C0001",
  "description": "调用第三方服务出错",
  "errorMsg": "鉴权失败！",
  "errorKey": "be_ErrorCode_C0001"
}
login