API-Übersicht - Archyl Docs

Erfahren Sie mehr über die Archyl-API und wie Sie sie in Ihre Tools und Workflows integrieren

API-Übersicht

Archyl bietet eine umfassende API, mit der Sie Architekturdokumentation in Ihre Workflows, Tools und Automatisierungspipelines integrieren können.

API-Endpunkte

Archyl bietet zwei API-Schnittstellen:

REST-API

Die REST-API bietet vollen Zugriff auf alle Archyl-Funktionen:

  • Projekte erstellen und verwalten
  • Architekturelemente hinzufügen, aktualisieren und löschen
  • Beziehungen verwalten
  • ADRs und Dokumentation handhaben
  • Diagramme exportieren

Basis-URL: https://api.archyl.com/api/v1

MCP-Server

Der Model Context Protocol (MCP) Server ermöglicht KI-Assistenten die Interaktion mit Ihrer Architektur:

  • Claude Code, Claude Desktop
  • Cursor
  • VS Code mit Copilot
  • Andere MCP-kompatible Tools

SSE-Endpunkt: https://api.archyl.com/sse HTTP-Endpunkt: https://api.archyl.com/mcp

Authentifizierung

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

curl -H "X-API-Key: ihr-api-schluessel" \
  https://api.archyl.com/api/v1/projects

API-Schlüssel Erstellen

  1. Gehen Sie zu Ihrem Profil → API-Schlüssel
  2. Klicken Sie auf "API-Schlüssel erstellen"
  3. Wählen Sie Berechtigungen (nur lesen oder lesen-schreiben)
  4. Kopieren und speichern Sie Ihren Schlüssel sicher

Schlüsselberechtigungen

Berechtigung Beschreibung
Lesen Projekte, Elemente und Dokumentation anzeigen
Schreiben Projekte, Elemente, Beziehungen erstellen und ändern

Schnellstart

Ihre Projekte Auflisten

curl -X GET \
  -H "X-API-Key: ihr-api-schluessel" \
  https://api.archyl.com/api/v1/projects

Ein System Erstellen

curl -X POST \
  -H "X-API-Key: ihr-api-schluessel" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "E-Commerce-Plattform",
    "description": "Haupt-E-Commerce-System",
    "type": "internal"
  }' \
  https://api.archyl.com/api/v1/projects/{projectId}/systems

Eine Beziehung Erstellen

curl -X POST \
  -H "X-API-Key: ihr-api-schluessel" \
  -H "Content-Type: application/json" \
  -d '{
    "sourceId": "system-1",
    "targetId": "system-2",
    "label": "Sendet Bestellungen an",
    "technology": "REST/HTTPS"
  }' \
  https://api.archyl.com/api/v1/projects/{projectId}/relationships

Fehlerbehandlung

API-Fehler geben Standard-HTTP-Statuscodes zurück:

Code Beschreibung
400 Ungültige Anfrage - Ungültige Parameter
401 Nicht autorisiert - Ungültiger oder fehlender API-Schlüssel
403 Verboten - Unzureichende Berechtigungen
404 Nicht gefunden - Ressource existiert nicht
500 Interner Serverfehler

Fehlerantworten enthalten Details:

{
  "error": {
    "code": "INVALID_PARAMETER",
    "message": "Name ist erforderlich",
    "field": "name"
  }
}

SDKs & Bibliotheken

Demnächst verfügbar:

  • JavaScript/TypeScript SDK
  • Python SDK
  • Go SDK

Anwendungsfälle

CI/CD-Integration

Architektur nach Deployments automatisch aktualisieren:

- name: Architektur Aktualisieren
  run: |
    curl -X POST \
      -H "X-API-Key: ${{ secrets.ARCHYL_API_KEY }}" \
      https://api.archyl.com/api/v1/projects/$PROJECT_ID/discover

Benutzerdefinierte Tools

Interne Tools erstellen, die mit Ihrer Architektur interagieren:

  • Architekturvalidierung
  • Compliance-Prüfung
  • Dokumentationsgenerierung

KI-Assistenten

MCP verwenden, um KI-Assistenten Ihre Architektur verstehen und aktualisieren zu lassen:

  • Fragen zu Ihrer Architektur stellen
  • Elemente durch natürliche Sprache erstellen
  • Dokumentation automatisch generieren

API-Dokumentation

Die vollständige interaktive API-Dokumentation ist verfügbar unter:

https://api.archyl.com/docs

Diese OpenAPI-Dokumentation enthält:

  • Alle verfügbaren Endpunkte
  • Request/Response-Schemas
  • Ausprobier-Funktionalität
  • Authentifizierungsbeispiele

Nächste Schritte