OpenAPI 是指云飞API侧提供 HTTP 接口，外部开发者发起调用，将数据传给云飞API或者从云飞API侧主动查询需要的数据。

1.OpenAPI请求协议说明

云飞API开放接口仅支持 http 协议接入，指定Content-Type为：application/json，支持的有POST和GET方法。
调用流程：获取调用 access_token -> 组装参数，拼装 HTTP 请求 -> 发起 HTTP 请求 -> 获得 HTTP 响应 -> 解析结果
调用地址：云飞API开放接口域名为 http://wspacebot.yunfeiwork.com
Header 的更多说明【Header 说明】部分。

Header头说明

请求头	值设置	示例	是否必填	描述
content-type	固定值"application/json"	application/json	是	数据协议类型

2.SDK

为了帮助开发者更加便捷地使用云飞API开放能力，简化在接入时的操作步骤，云飞API提供了统一的服务端 OpenAPI SDK。开发者可使用OpenAPI SDK，快捷地接入云飞API提供的服务端接口，提升开发效率。当前OpenAPI SDK支持 Java 语言，后续将持续扩展。

Java SDK，已开源 tuangou-java

Java接入

包引入

你可以点我查看settings.xml配置，或者按照以下指南自行配置。

步骤一：设置仓库凭证

请在 settings.xml 文件<servers></servers>中设置以下仓库的访问凭证，通常settings.xml在$HOME/.m2/文件目录下。

<servers>
  <server>
    <id>tuangou-java</id>
    <username>6775f438d497cd558d6307ba</username>
    <password>7x9I6tkB]mKv</password>
  </server>
</servers>

步骤二：配置仓库和包信息

在settings.xml文件<repositories></repositories>节点中加入对应的仓库使用地址。

<repositories>
  <repository>
    <id>tuangou-java</id>
    <url>https://packages.aliyun.com/692c1367ccf3499544d9cf5a/maven/tuangou-java</url>
    <releases>
      <enabled>true</enabled>
    </releases>
    <snapshots>
      <enabled>true</enabled>
    </snapshots>
  </repository>
</repositories>

在你项目的pom.xml文件<denpendencies></denpendencies>节点中加入你要引用的文件信息。

<dependency>
    <groupId>com.yunfeiwork</groupId>
    <artifactId>tuangou-java-partner</artifactId>
    <version>1.0.B</version>
</dependency>

步骤三：拉取

运行以下命令完成jar拉取。

mvn install

代码调用示例

查看源代码调用示例

响应示例

参数	类型	描述
code	int	状态码，200为成功，非200代表有错误
msg	string	状态描述
data	struct	业务数据，可能是 object 也可以是 arrays
tid	string	云飞API侧日志 id，可用于排查问题

下面的示例代码以《查询应用余额》对应的接口为例。

{
    "code": 200,
    "msg": "验证成功",
    "data": {
        "balance": 100
    },
    "tid": "202412112134332BEA1F1E7DB8F93AE378"
}

OpenAPI接口调用约定

1.OpenAPI请求协议说明#

Header头说明#

2.SDK#

Java接入#

包引入#

代码调用示例#