Wie erstelle ich einen API-Schlüssel für Agile E-Mail?
Unter „API und Webhooks“ in der Karte „API-Schlüssel“ Name, Ablauf und Rechte wählen und „Schlüssel erzeugen“ klicken. Der Schlüssel wird nur einmal angezeigt.
API-Schlüssel erzeugen
- Öffnen Sie in der Seitenleiste API und Webhooks.
- In der Karte API-Schlüssel: Name vergeben, optional Läuft ab setzen und unter Rechte nur das ankreuzen, was Ihre Anwendung braucht (Domains, Postfächer, Aliasse und Konto jeweils lesen oder schreiben, Webhooks verwalten).
- Klicken Sie auf Schlüssel erzeugen.
Der Schlüssel beginnt mit agile_mail_ und wird nur einmal angezeigt. Bewahren Sie ihn sicher auf. Nicht mehr gebraucht? Mit Widerrufen sofort ungültig machen.
Schnittstelle nutzen
- REST unter
/api/v1/…, Schlüssel im HeaderAuthorization: Bearer agile_mail_… - Dokumentation: Knopf API-Doku bzw.
/docs, Spezifikation unter/api/openapi.json
Webhooks
In der Karte Webhooks tragen Sie eine Ziel-URL ein und klicken Webhook anlegen. Mit Test senden probieren Sie ihn aus, unter Protokoll sehen Sie die Zustellungen. Jede Zustellung ist über den Header Agile-Signature signiert.
War dieser Artikel hilfreich?