API リファレンス

Architecto にプログラムからアクセスするための開発者向けドキュメント

Architecto API を使うと、プラットフォーム上に独自のアプリケーション、連携、ワークフローを構築できます。

認証

すべての API リクエストで、API キーによる認証が必要です。

Authorization: Bearer YOUR_API_KEY

API キーの作成

  1. 設定 → 開発者 → API キー に移動します
  2. 新しいキーを作成 をクリックします
  3. 名前と有効期限(無期限、30 日、90 日、1 年)を入力します
  4. スコープ(読み取り、書き込み、管理)を選択します
  5. キーをコピーします(一度だけ表示されます)

API キーを公開しないでください。 パスワードと同様に扱ってください。

API キーの失効

  1. 設定 → 開発者 → API キー に移動します
  2. キーの横にある 失効 をクリックします
  3. 即座に無効になります

ベース URL

すべての API エンドポイントは、次の URL で利用できます。

https://api.architecto.dev/v1

主なエンドポイント

認証

POST /auth/login          # Login and get session
POST /auth/logout         # End session
POST /auth/refresh        # Refresh access token

アーキテクチャ

GET    /architectures              # List your architectures
POST   /architectures              # Create new architecture
GET    /architectures/{id}         # Get architecture details
PUT    /architectures/{id}         # Update architecture
DELETE /architectures/{id}         # Delete architecture
GET    /architectures/{id}/versions # Get version history

分析

POST   /architectures/{id}/analyze/cost         # Run cost analysis
POST   /architectures/{id}/analyze/scalability  # Run scalability analysis
POST   /architectures/{id}/analyze/threats      # Run threat modeling

ドキュメント

POST   /architectures/{id}/documents/rfc        # Generate RFC
POST   /architectures/{id}/documents/adr        # Generate ADR
POST   /architectures/{id}/documents/runbook    # Generate runbook

共有

POST   /architectures/{id}/shares      # Create share link
GET    /shares/{token}                 # Get shared architecture
POST   /shares/{token}/comments        # Add comment to shared arch

チーム

GET    /organizations                  # List your organizations
POST   /organizations                  # Create organization
GET    /organizations/{id}/members     # List team members
POST   /organizations/{id}/invites     # Invite team member

エラー処理

API エラーでは、標準の HTTP ステータスコードが返されます。

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Architecture with id 'arch_123' not found",
    "details": {
      "resource_type": "architecture",
      "resource_id": "arch_123"
    }
  }
}

主なステータスコード

コード意味
200成功
400不正なリクエスト(無効なパラメーター)
401認証エラー(無効な API キー)
403アクセス禁止(権限不足)
404見つかりません
429レート制限超過
500サーバーエラー

レート制限

API リクエストには、次のレート制限があります。

  • Free プラン: 100 リクエスト/時間
  • Pro プラン: 1,000 リクエスト/時間
  • Ultimate プラン: 10,000 リクエスト/時間

レート制限の情報は、レスポンスヘッダーに含まれます。

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

例:アーキテクチャの作成と分析

# 1. Create architecture
curl -X POST https://api.architecto.dev/v1/architectures \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "E-commerce Platform",
    "description": "Multi-region e-commerce with real-time inventory",
    "cloud_provider": "aws"
  }'

# Response:
# {
#   "id": "arch_abc123",
#   "title": "E-commerce Platform",
#   "created_at": "2024-01-15T10:30:00Z"
# }

# 2. Run cost analysis
curl -X POST https://api.architecto.dev/v1/architectures/arch_abc123/analyze/cost \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scale_points": [1000, 10000, 100000],
    "region": "us-east-1"
  }'

# Response:
# {
#   "analysis_id": "analysis_xyz789",
#   "estimates": [
#     {
#       "users": 1000,
#       "monthly_cost": 150,
#       "breakdown": { "compute": 80, "storage": 40, "data_transfer": 30 }
#     },
#     ...
#   ]
# }

Webhook(近日公開)

アーキテクチャのイベントを購読できます。

POST /webhooks
{
  "url": "https://your-app.com/webhook",
  "events": ["architecture.created", "architecture.updated", "analysis.completed"]
}

SDK

次の言語向け公式 SDK を近日公開予定です。

  • Python
  • Node.js / TypeScript
  • Go
  • Ruby
  • Java

対話型 API ドキュメント

コードを書かずに API を試せます。

サポート


次のステップ:

Architecto Logo

Architecto

クラウドアーキテクチャの設計、文書化、レビュー、ガバナンスに対応する、エンタープライズ品質の AI プラットフォーム。

API リファレンス | ドキュメント | Architecto