跳到主要内容

API 概述

ArchiCore REST API 允许您将架构分析集成到您的工作流程中。

基础 URL​

https://api.archicore.io/api/v1

认证​

所有 API 请求都需要使用 Bearer 令牌进行认证：

curl -H "Authorization: Bearer 您的_API_密钥" \
  https://api.archicore.io/api/v1/projects

请参阅认证了解如何获取 API 密钥。

响应格式​

所有响应均为 JSON 格式：

{
  "success": true,
  "data": { ... }
}

错误响应：

{
  "success": false,
  "error": "错误信息",
  "code": "错误代码"
}

HTTP 状态码​

代码描述
200成功
201已创建
400错误请求 - 无效参数
401未授权 - 无效或缺少令牌
403禁止 - 权限不足
404未找到
429请求过多 - 超出速率限制
500内部服务器错误

速率限制​

层级每日请求数每分钟请求数
免费10010
专业10,000100
企业无限制1,000

速率限制标头包含在所有响应中：

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

端点摘要​

项目​

方法端点描述
GET/projects列出所有项目
POST/projects创建项目
GET/projects/:id获取项目详情
DELETE/projects/:id删除项目
POST/projects/:id/index触发索引

分析​

方法端点描述
POST/projects/:id/search语义搜索
POST/projects/:id/ask询问 AI 助手
GET/projects/:id/metrics获取代码指标
GET/projects/:id/security安全扫描结果
POST/projects/:id/analyze影响分析

Webhooks​

方法端点描述
GET/webhooks列出 webhooks
POST/webhooks创建 webhook
DELETE/webhooks/:id删除 webhook

SDK​

官方 SDK 可用于：

  • JavaScript/TypeScript：npm install @archicore/sdk
  • Python：pip install archicore

快速示例​

import { ArchiCore } from '@archicore/sdk';

const client = new ArchiCore({ apiKey: '您的_API_密钥' });

// 搜索代码
const results = await client.projects.search('project-id', {
  query: '认证逻辑'
});

// 询问 AI
const answer = await client.projects.ask('project-id', {
  question: '认证系统是如何工作的？'
});