Rujukan API

Dokumentasi pembangun untuk akses pengaturcaraan kepada Architecto

API Architecto membolehkan anda membina aplikasi, penyepaduan dan aliran kerja tersuai di atas platform.

Pengesahan

Semua permintaan API memerlukan pengesahan dengan kekunci API:

Authorization: Bearer YOUR_API_KEY

Mencipta kekunci API

Buka Tetapan → Pembangun → Kekunci API.
Klik Cipta kekunci baharu.
Masukkan nama dan tempoh sah: tidak pernah, 30 hari, 90 hari atau 1 tahun.
Pilih skop baca, tulis atau pentadbir.
Salin kekunci yang hanya dipaparkan sekali.

Jangan kongsi kekunci API secara terbuka. Lindunginya seperti kata laluan.

Membatalkan kekunci API

Buka Tetapan → Pembangun → Kekunci API.
Klik Batalkan di sebelah kekunci.
Pembatalan berkuat kuasa serta-merta.

URL asas

Semua titik akhir tersedia di:

https://api.architecto.dev/v1

Titik akhir lazim

Pengesahan

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

Seni bina

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

Analisis

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

Dokumentasi

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

Pasukan

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

Pengendalian ralat

Ralat API mengembalikan kod status HTTP standard:

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

Kod status lazim

Kod	Maksud
200	Berjaya
400	Permintaan tidak sah: parameter salah
401	Tidak disahkan: kekunci API tidak sah
403	Dilarang: kebenaran tidak mencukupi
404	Tidak ditemukan
429	Had permintaan dicapai
500	Ralat pelayan

Pengehadan permintaan

Had API ialah:

Pelan Free: 100 permintaan sejam.
Pelan Pro: 1,000 permintaan sejam.
Pelan Ultimate: 10,000 permintaan sejam.

Maklumat had terdapat dalam pengepala respons:

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

Contoh: cipta dan analisis seni bina

# 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: akan datang

Langgan peristiwa seni bina:

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

SDK

SDK rasmi akan tersedia untuk:

Python
Node.js / TypeScript
Go
Ruby
Java

Dokumentasi API interaktif

Cuba API tanpa menulis kod:

Sokongan

Masalah API: laporkan di GitHub Issues.
Soalan: tanya di Discord komuniti.
Perusahaan: hubungi sales@architecto.dev.

Langkah seterusnya:

Panduan penyepaduan
Persediaan webhook (akan datang)

Rujukan API

Pada halaman ini