API-Übersicht

Die ArchiCore REST-API ermöglicht es Ihnen, Architekturanalysen in Ihre Workflows zu integrieren.

Basis-URL

https://api.archicore.io/api/v1

Authentifizierung

Alle API-Anfragen erfordern eine Authentifizierung mit einem Bearer-Token:

curl -H "Authorization: Bearer IHR_API_SCHLÜSSEL" \
  https://api.archicore.io/api/v1/projects

Siehe Authentifizierung für Details zum Erhalt von API-Schlüsseln.

Antwortformat

Alle Antworten sind JSON:

{
  "success": true,
  "data": { ... }
}

Fehlerantworten:

{
  "success": false,
  "error": "Fehlermeldung",
  "code": "FEHLER_CODE"
}

HTTP-Statuscodes

Code	Beschreibung
200	Erfolg
201	Erstellt
400	Fehlerhafte Anfrage - Ungültige Parameter
401	Nicht autorisiert - Ungültiges oder fehlendes Token
403	Verboten - Unzureichende Berechtigungen
404	Nicht gefunden
429	Zu viele Anfragen - Ratenlimit überschritten
500	Interner Serverfehler

Ratenlimits

Stufe	Anfragen/Tag	Anfragen/Minute
Kostenlos	100	10
Pro	10.000	100
Enterprise	Unbegrenzt	1.000

Ratenlimit-Header sind in allen Antworten enthalten:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

Endpoint-Übersicht

Projekte

Methode	Endpoint	Beschreibung
GET	/projects	Alle Projekte auflisten
POST	/projects	Projekt erstellen
GET	/projects/:id	Projektdetails abrufen
DELETE	/projects/:id	Projekt löschen
POST	/projects/:id/index	Indexierung starten

Analyse

Methode	Endpoint	Beschreibung
POST	/projects/:id/search	Semantische Suche
POST	/projects/:id/ask	KI-Assistent fragen
GET	/projects/:id/metrics	Code-Metriken abrufen
GET	/projects/:id/security	Sicherheitsscan-Ergebnisse
POST	/projects/:id/analyze	Auswirkungsanalyse

Webhooks

Methode	Endpoint	Beschreibung
GET	/webhooks	Webhooks auflisten
POST	/webhooks	Webhook erstellen
DELETE	/webhooks/:id	Webhook löschen

SDKs

Offizielle SDKs verfügbar für:

• JavaScript/TypeScript: npm install @archicore/sdk
• Python: pip install archicore

Schnellbeispiel

import { ArchiCore } from '@archicore/sdk';

const client = new ArchiCore({ apiKey: 'IHR_API_SCHLÜSSEL' });

// Code suchen
const results = await client.projects.search('project-id', {
  query: 'Authentifizierungslogik'
});

// KI fragen
const answer = await client.projects.ask('project-id', {
  question: 'Wie funktioniert das Authentifizierungssystem?'
});