goodwe-logo开放平台

概览

接口架构

本系统为第三方系统及第三方开发者提供了一套http接口,第三方系统或 第三方开发者可以构造Https请求来调用API接口,获取本系统的资源及数据。

图1-1 HTTP接口架构图
api-arch

对接方法

访问格式及路径

访问格式:https://管理系统域名/具体的 API 接口名称+访问请求参数

第三方系统与本系统通信过程

图1-2 第三方系统与本系统通信过程
api-arch
说明:
  1. 请提供调用ip,由管理员录入到白名单中;
  2. 管理员在权限系统上配置好租户信息后,提供给租户AppId和AppSecret便于接口服务登录;
  3. 接口服务登录成功后,返还TOKEN;
  4. TOKEN为跨站请求令牌,用户使用AppId和AppSecret登录系统之后,系统会给用户返回该 令牌,用户在后续请求中带上令牌就标识着该请求是已登录用户发起的请求。

接口变更声明

  • 所有新增或者变更的API接口均会在变更说明中描述。
  • 对于生命周期管理要结束的API,会先在本文档中声明API废弃,请预留足够切换 时间。
  • 对于在文档中声明即将下线的API接口,新建的用户不能调用,否则在此后系 统升级时将返回错误。