快速开始

# 📦 Java版本SDK

拥有 Java 开发环境以及相应 IDE
熟悉 Spring Boot
熟悉 Maven

# 🍊 Maven

在项目的pom.xml的dependencies中加入以下内容:（必选）

<dependency>
    <groupId>com.vampon</groupId>
    <artifactId>vam-api-sdk</artifactId>
    <version>0.0.1</version>
</dependency>

1
2
3
4
5

提示 🔔️

JDK 8 +

# ⚙️ 配置客户端

# 1. 前往VAM-API 接口开放平台 (opens new window) 获取开发者密钥对

# 2. 初始化客户端VamApiClient对象

方法 1 ：主动实例化客户端

String accessKey = "你的 accessKey";
String secretKey = "你的 secretKey";
VamApiClient client = new VamApiClient(accessKey, secretKey);

1
2
3

方法 2 ：通过配置文件注入对象

yml

# VAM-API 配置
vamapi:
  client:
    access-key: 你的 accessKey
    secret-key: 你的 secretKey

1
2
3
4
5

properties

vamapi.client.access-key=你的 accessKey
vamapi.client.secret-key=你的 secretKey

1
2

# 3. 使用API服务

 @Resource
 private VamApiClient vamApiClient;

1
2

# 4. 请求参数

GET请求：对于GET请求，请求参数多个参数之间使用&符号分隔。每个参数的名值对之间通过=连接。例如

    value1=param1&&value2=param2

POST请求：对于POST请求，应先将参数转换成JSON格式，例如

    {
        "value1": param1,
        "value2": param2,
        "value3": param3
    }

1
2
3
4
5

# 5. 发起请求示例

示例：

public void request() {
    try {
        String method ="GET";
        String path = "/api/FortuneTellers";
        String requestParams = "birthTime=1998年6月2日&&gender=男&&birthPlace=黑龙江哈尔滨&&currentQuestion=今年的事业运如何";
        String invokeResult = vamApiClient.invokeInterface(requestParams, method, path);
        System.out.println(invokeResult);
    } catch (Exception e) {
        log.error(e.getMessage());
    }
}

1
2
3
4
5
6
7
8
9
10
11

响应示例：

{
  "code": 0,
  "data": "根据你提供的生辰信息，今年你的事业运势整体呈现上升趋势。你将面临一些新的机遇和挑战，但只要保持积极心态，勇于面对困难，就能够顺利实现事业目标。记住，机遇与努力并存，祝你好运！",
  "message": "ok"
}

1
2
3
4
5

# 📦 C语言版本SDK

前往C语言SDK (opens new window) 获取C语言版本SDK

# 发起请求示例

示例：

int main() {
    // Example usage
    const char* access_key = "your_access_key";
    const char* secret_key = "your_secret_key";
    const char* gateway_host = DEFAULT_GATEWAY_HOST;
    const char* params = "param1=value1&param2=value2";
    const char* method = "GET";
    const char* path = "/api/example";

    char* result = invoke_interface(access_key, secret_key, gateway_host, params, method, path);
    if (result) {
        printf("API response: %s\n", result);
        free(result);
    }
    return 0;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

示例代码中包含了一些基本的错误处理。如果请求失败或返回错误，你可以在 write_callback 函数中扩展错误处理逻辑。

# 📦 Python版本SDK

前往Python语言SDK (opens new window) 获取Python语言版本SDK

# 发起请求示例

if __name__ == "__main__":
    client = VamApiClient("your_access_key", "your_secret_key")
    params = "param1=value1&param2=value2"
    method = "GET"
    path = "/api/example"

    result = client.invoke_interface(params, method, path)
    print(f"API response: {result}")

1
2
3
4
5
6
7
8

# 🐞 提供bug反馈或建议

提交问题反馈(403500543@qq.com)请说明正在使用的JDK版本、VAM-API-SDK版本和相关依赖库版本。

帮助我们改善此页面！

← 简介返回响应码→