View Categories

快速开始 – API 接入指南与 SDK 下载

快速开始 – API 接入指南与 SDK 下载

3分钟快速接入可立图 API。
本指南将引导您完成 API Key 获取、SDK 下载及环境配置，助您快速集成企业级 AI 图像处理能力。

1. 接入流程概览 #

  1. 注册/登录：创建可立图账号。
  2. 获取凭证：在开发者中心获取 API Key。
  3. 下载 SDK：选择适合您开发语言的 SDK 包。
  4. 调试调用：运行示例代码，发起第一次请求。

2. 获取 API Key #

API Key 是您调用接口的唯一身份凭证，请务必妥善保管。

  1. 登录 可立图用户中心。
  2. 进入 “开发者中心” 或 “API 管理” 页面。
  3. 点击 “生成/查看 API Key” 按钮。
  4. 复制您的 Key 字符串（例如：sk_test_1234567890abcdef）。

安全提示：请勿将 API Key 直接硬编码在客户端代码（如 JS、Android App）中，以免泄露导致账户被盗用。建议仅在服务端存储和使用。

3. SDK 下载与环境配置 #

我们提供了主流编程语言的官方 SDK 及 Demo 工程，封装了签名算法和 HTTP 请求逻辑，开箱即用。

Java SDK #

  • 适用版本：JDK 1.8+
  • 下载地址：点击下载 Java SDK 包
  • Maven 依赖：<dependency> <groupId>com.clipimg</groupId> <artifactId>clipimg-sdk</artifactId> <version>1.0.0</version> </dependency>

PHP SDK #

  • 适用版本：PHP 7.0+
  • 下载地址：点击下载 PHP SDK 包
  • 安装说明：下载解压后，在项目中引入 autoload.php 即可。

Python SDK #

4. 快速调用示例 (Hello World) #

以下以 人像抠图 API 为例，展示如何发起一次简单的调用。

Python 示例代码 #

import requests

# 1. 配置 API Key 和 目标 URL
api_key = "YOUR_API_KEY_HERE"
url = "https://www.clipimg.com/api/human/matting"

# 2. 准备图片文件
files = {
    'file': open('test.jpg', 'rb')
}

# 3. 准备参数 (format=png 表示直接返回图片流)
data = {
    'format': 'png'
}

# 4. 发起 POST 请求
headers = {
    'X-API-Key': api_key
}
response = requests.post(url, files=files, data=data, headers=headers)

# 5. 处理响应
if response.status_code == 200:
    # 保存处理后的图片
    with open('result.png', 'wb') as f:
        f.write(response.content)
    print("处理成功，图片已保存为 result.png")
else:
    print(f"调用失败: {response.text}")

5. 常见问题 (FAQ) #

Q: 调用返回 401 Unauthorized？
A: 请检查 Header 中的 X-API-KEY 是否正确设置，或者 API Key 是否已过期/被禁用。

Q: 图片上传有什么限制？
A: 目前支持 JPG/PNG 格式，单张图片大小不超过 10MB，分辨率建议在 2000×2000 以内。

Q: 如何查看剩余点数？
A: 请前往 用户中心 查看当前账户余额及消费明细。

6. 下一步 #