裕普智汇

调用 API 接口

完整的 API 调用指南，助您快速集成裕普智汇服务

API 概述

裕普智汇提供完整的 RESTful API 接口，支持安全巡检、配置管理、日志分析等功能。所有 API 均通过 HTTPS 访问，返回 JSON 格式数据。接口遵循统一的认证和限流机制，确保服务稳定性。

认证方式

API密钥

在账户设置中创建 API 密钥，通过 Header 传递

X-API-Key: your_api_key

JWT令牌

使用账号密码换取短期访问令牌，适合前端调用

Authorization: Bearer jwt_token

请求格式

所有请求需要包含以下 Header 信息：Content-Type: application/json、Accept: application/json。根据接口不同，支持 GET、POST、PUT、DELETE 等 HTTP 方法。请求体中的日期格式使用 ISO 8601 标准。

主要端点

项目

GET /api/projectsPOST /api/projectsPUT /api/projects/{id}DELETE /api/projects/{id}

设备

GET /api/devicesPOST /api/devicesPUT /api/devices/{id}DELETE /api/devices/{id}

任务

GET /api/tasksPOST /api/tasksGET /api/tasks/{id}/statusPOST /api/tasks/{id}/cancel

报告

GET /api/reportsGET /api/reports/{id}GET /api/reports/{id}/download

调用示例

Python 调用示例

import requests

API_KEY = "your_api_key_here"
BASE_URL = "https://api.yupu.cn/v1"

headers = {
    "X-API-Key": API_KEY,
    "Content-Type": "application/json"
}

# 获取项目列表
response = requests.get(
    f"{BASE_URL}/projects",
    headers=headers
)
print(response.json())

cURL 调用示例

# 获取项目列表
curl -X GET "https://api.yupu.cn/v1/projects" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json"

# 创建新任务
curl -X POST "https://api.yupu.cn/v1/tasks" \
  -H "X-API-Key: your_api_key_here" \
  -d '{"project_id": 1, "type": "security_scan"}'

限流说明

API 访问采用限流机制，默认每秒 10 次请求。企业账户可根据套餐提升限流额度。限流时会返回 429 状态码，建议客户端实现指数退避重试策略。

错误处理

错误码含义解决方法
400请求参数错误检查请求体格式和参数类型
401认证失败检查 API 密钥是否正确
403权限不足检查账户权限设置
404资源不存在检查请求的资源ID
429请求过于频繁降低请求频率，实现重试机制
500服务器内部错误联系技术支持

常见问题

API 密钥如何获取？

登录控制台后，进入"账户设置"-"API密钥"页面，点击"创建密钥"生成。

请求超时怎么办？

建议设置合理的超时时间（建议 30 秒），并实现重试机制。

如何查看 API 调用记录？

在控制台"开发者中心"-"API日志"中可以查看详细的调用记录。

支持 Webhook 回调吗？

支持，任务完成后系统可以主动回调您指定的 URL，详见 Webhook 配置文档。

← 返回文档中心