API-Referenz

Entwicklerdokumentation für den programmatischen Zugriff auf Architecto

Mit der Architecto-API erstellen Sie eigene Anwendungen, Integrationen und Arbeitsabläufe auf Basis der Plattform.

Authentifizierung

Alle API-Anfragen erfordern die Authentifizierung mit einem API-Schlüssel:

Authorization: Bearer YOUR_API_KEY

API-Schlüssel erstellen

Öffnen Sie Einstellungen → Entwickler → API-Schlüssel.
Klicken Sie auf Neuen Schlüssel erstellen.
Geben Sie Namen und Ablauf an: nie, 30 Tage, 90 Tage oder 1 Jahr.
Wählen Sie Lese-, Schreib- oder Administrationsberechtigungen.
Kopieren Sie den nur einmal angezeigten Schlüssel.

Geben Sie API-Schlüssel niemals öffentlich weiter. Behandeln Sie sie wie Passwörter.

API-Schlüssel widerrufen

Öffnen Sie Einstellungen → Entwickler → API-Schlüssel.
Klicken Sie neben dem Schlüssel auf Widerrufen.
Der Widerruf gilt sofort.

Basis-URL

Alle API-Endpunkte sind hier verfügbar:

https://api.architecto.dev/v1

Häufige Endpunkte

Authentifizierung

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

Architekturen

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

Analyse

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

Dokumentation

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

Teams

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

Fehlerbehandlung

API-Fehler liefern standardmäßige HTTP-Statuscodes:

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

Häufige Statuscodes

Code	Bedeutung
200	Erfolgreich
400	Ungültige Anfrage oder Parameter
401	Nicht authentifiziert: ungültiger API-Schlüssel
403	Verboten: unzureichende Berechtigungen
404	Nicht gefunden
429	Anfragelimit erreicht
500	Serverfehler

Anfragelimits

Für API-Anfragen gelten diese Grenzen:

Free-Tarif: 100 Anfragen pro Stunde.
Pro-Tarif: 1,000 Anfragen pro Stunde.
Ultimate-Tarif: 10,000 Anfragen pro Stunde.

Angaben dazu stehen in den Antwort-Headern:

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

Beispiel: Architektur erstellen und analysieren

# 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 }
#     },
#     ...
#   ]
# }

Webhooks: demnächst

Abonnieren Sie Architekturereignisse:

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

SDKs

Offizielle SDKs folgen für:

Python
Node.js / TypeScript
Go
Ruby
Java

Interaktive API-Dokumentation

Testen Sie die API ohne eigenen Code:

Unterstützung

API-Probleme: melden Sie sie in GitHub Issues.
Fragen: fragen Sie im Community-Discord.
Unternehmen: kontaktieren Sie sales@architecto.dev.

Nächste Schritte:

Integrationsleitfaden
Webhook-Einrichtung (demnächst)

API-Referenz

Auf dieser Seite