> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.autophish.io/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Öffentliche API und API-Schlüssel

Mit der öffentlichen AutoPhish-API kannst du Aufgaben automatisieren, die du sonst in der App erledigen würdest – zum Beispiel Kampagnen erstellen, Ziellisten synchron halten oder Ergebnisse in dein eigenes Reporting übernehmen. Dieser Artikel erklärt, wie du einen API-Schlüssel erstellst und dich authentifizierst.

## Was du mit der API tun kannst

Die API deckt die wichtigsten Bereiche von AutoPhish ab:

- Unternehmen und Unternehmenseinstellungen (Kontext, Logo, verifizierte E-Mail-Domains)
- Kampagnen – erstellen, aktualisieren, klonen, planen und abbrechen, außerdem ihre Ausführungen
- Ziellisten und Ziele
- Berichte – Zusammenfassung, Ziele, Trends und Export
- Teammitglieder und Einladungen
- Domains, Sicherheits-Scans und Probleme
- Gemeldete Phishing-E-Mails
- Protokoll (Audit Log) und Verzeichnissynchronisierung (Directory Sync)

Die vollständige Referenz ist als interaktive OpenAPI-Dokumentation unter <https://autophish.io/docs/api> verfügbar. Die OpenAPI-Spezifikation selbst kannst du unter `/api/v1/openapi.json` oder `/api/v1/openapi.yaml` herunterladen.

## API-Schlüssel erstellen

1. Gehe zu **Einstellungen → API Keys**.
2. Gib unter **Create API key** einen **Name** ein (zum Beispiel „Reporting-Integration“).
3. Gib optional **Allowed IPs** an – eine pro Zeile oder durch Kommas getrennt. Unterstützt werden nur IPv4-/IPv6-Adressen, noch keine Bereiche. Lässt du das Feld leer, ist jede IP erlaubt.
4. Wähle unter **Companies** die Unternehmen aus, auf die dieser Schlüssel zugreifen darf.
5. Wähle die **Scopes**, die der Schlüssel braucht, oder nutze eine Voreinstellung:
   - **Read-only** – Unternehmen, Kampagnen, Ziele, Berichte, Team und Integrationen lesen
   - **Campaign automation** – Unternehmen lesen, Kampagnen und Ziele lesen und schreiben, Berichte lesen
   - **Admin operations** – Unternehmens- und Teameinstellungen lesen und schreiben
6. Klicke auf **Create key**.

![Formular zum Erstellen eines API-Schlüssels mit Name, erlaubten IPs, Unternehmen und Scopes](https://storage.crisp.chat/users/helpdesk/website/-/4/3/7/4/437439cedb096800/api-keys_vdi2fs.jpg)

Das Token wird **nur einmal** angezeigt. Kopiere es mit **Copy** und speichere es sicher, zum Beispiel in deinem Passwortmanager oder Secret Store. Tokens beginnen mit `apk_`.

Vergib nur die Scopes, die eine Integration wirklich braucht, und beschränke Schlüssel nach Möglichkeit auf feste IP-Adressen.

## Anfragen authentifizieren

Sende den Schlüssel als Bearer-Token und nenne in jeder Anfrage das Unternehmen:

```
Authorization: Bearer apk_...  
X-Company-Id: <your company ID>
```

Die Unternehmens-IDs stehen neben jedem Unternehmen im Bereich **Companies** der Seite „API Keys“. Der Header `X-Company-Id` ist auch dann erforderlich, wenn der Schlüssel nur Zugriff auf ein Unternehmen hat. `https://autophish.io/api/v1/` ist die Basis-URL aller Endpunkte.

Anfragen sind pro Schlüssel und Unternehmen ratenbegrenzt. Die aktuellen Limits werden in `X-RateLimit-*`-Headern zurückgegeben; wenn du sie überschreitest, antwortet die API mit dem Status 429.

## Schlüssel verwalten und widerrufen

Die Tabelle **Your API keys** zeigt jeden Schlüssel mit Präfix, Scopes, erlaubten IPs, letzter Nutzung und Status. Du kannst ändern, auf welche Unternehmen ein Schlüssel zugreifen darf, und einen Schlüssel jederzeit mit **Revoke** widerrufen – das lässt sich nicht rückgängig machen.

## Wer Schlüssel erstellen kann

- Du kannst einen Schlüssel nur Unternehmen zuweisen, in denen du Admin oder Eigentümer bist.
- Ein Schlüssel funktioniert nur so lange, wie sein Ersteller Admin oder Eigentümer dieses Unternehmens ist. Wird ein Mitglied entfernt, verlieren seine Schlüssel den Zugriff auf dieses Unternehmen.
- Unternehmenseigentümer sehen **External API keys with company access** – Schlüssel, die andere Benutzer erstellt haben – und können deren Zugriff mit **Remove access** entfernen.

Das Erstellen, Ändern und Widerrufen von Schlüsseln sowie jeder API-Aufruf werden im **Protokoll** aufgezeichnet.