使用流程
开发者平台接口以标准HTTP的方式提供,任何语言几乎都可以使用HTTP方式调用。
同时为了方便开发者使用,开发者平台提供了几种常用语言的sdk封装包,支持java、JavaScript、TypeScript包,可以引入到工程中直接调用类和方法。
## HTTP方式使用
> 注: 如果您的开发语言有相应的SDK支持,则推荐使用SDK方式调用。
几乎所有HTTP接口遵循以下规则,有特殊接口则在文档中有相应说明。
**请求方法**
post
**请求数据类型/ContentType**
application/json (raw/json)
**响应数据格式**
json
**数据编码**
utf-8
**认证授权**
Bearer Token
> 即Headers中加入授权头,key为Authorization,value为Bearer + 空格 + access_token:
> Authorization: Bearer e10adc3949ba59abbe56e057f20f883e
## SDK方式使用
### java
以maven工程为例
**1.添加依赖**
下载jar包后,通过以下pom引入到您的maven工程:
> 项目pom依赖
```xml
<dependency>
<groupId>com.mn</groupId>
<artifactId>mncloud-sdk</artifactId>
<version>1.0.0</version>
<scope>system</scope>
<systemPath>D:/your_path/mncloud-sdk-1.0.0.jar</systemPath>
</dependency>
```
**2.初始化**
在使用sdk之前,需要在您的项目中做一个简单的初始化配置,用于指定目标服务器地址、HTTP通讯参数等。
```java
private void initApiClient() {
ApiClient apiClient = Configuration.getDefaultApiClient();
apiClient.setBasePath("http://localhost");
apiClient.setConnectTimeout(3000);
apiClient.setReadTimeout(15000);
apiClient.setWriteTimeout(3000);
}
```
**3.认证授权与调用示例**
```java
//实例化api类,传入token
//此处的token可以是由前端传递过来的当前用户token、或是后台主动获取的token
ProjectApi apiInstance = new ProjectApi("e10adc3949ba59abbe56e057f20f883e");
try {
ResultListProjectVo result = apiInstance.getAuthorizedProjects();
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ProjectApi.getAuthorizedProjects异常: " + e.getMessage());
e.printStackTrace();
}
```
### JavaScript/TypeScript
**1.引入文件**
下载压缩包,解压到您的项目源码目录中。
直接import导入使用
**2.配置请求路径**
```JavaScript
//一般为当前浏览器地址栏域名
setBasePath("/")
```
**3.授权**
```JavaScript
//前端调用接口时,当前页面的token不会变化,每次全局初始化时设置一次即可
setAccessToken("e10adc3949ba59abbe56e057f20f883e")
```