メインコンテンツまでスキップ

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
Pro10,000100
Enterprise無制限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/askAI アシスタントに質問
GET/projects/:id/metricsコードメトリクスを取得
GET/projects/:id/securityセキュリティスキャン結果
POST/projects/:id/analyze影響分析

Webhooks​

メソッドエンドポイント説明
GET/webhooksWebhook を一覧表示
POST/webhooksWebhook を作成
DELETE/webhooks/:idWebhook を削除

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: '認証システムはどのように動作しますか？'
});