REST-API und Webhooks
Agile Git per API steuern und andere Systeme bei Ereignissen automatisch benachrichtigen.
API-Adresse und Dokumentation
- Basisadresse:
https://git.agiledeveloper.de/api/v1 - Interaktive Dokumentation: https://git.agiledeveloper.de/api/swagger
- OpenAPI-Datei: https://git.agiledeveloper.de/swagger.v1.json
Anmelden
Erzeugen Sie unter Einstellungen → Anwendungen ein Zugriffstoken und senden Sie es im Header Authorization:
curl -H "Authorization: token IHR-TOKEN" \
https://git.agiledeveloper.de/api/v1/userBeispiel: Issue anlegen
Das Token braucht dafür die Berechtigung issue mit Lesen und Schreiben.
curl -X POST \
-H "Authorization: token IHR-TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Fehler im Checkout"}' \
https://git.agiledeveloper.de/api/v1/repos/IHR-NAME/shop/issuesBerechtigungen
Berechtigungen gelten je Bereich, jeweils als Lesen oder als Lesen und Schreiben. Die wichtigsten sind repository, issue, organization, package, user und notification. Ein Token braucht mindestens eine Berechtigung.
Seiten abrufen
Listen teilen Sie mit den Parametern page und limit auf. Ohne Angabe liefert die API 30 Einträge, höchstens 50 je Abruf. Die Gesamtzahl steht im Header x-total-count.
Webhooks
Webhooks senden bei Ereignissen eine Anfrage an Ihren Server, zum Beispiel bei einem Push.
- Öffnen Sie Einstellungen des Repositorys → Webhooks.
- Klicken Sie auf Webhook hinzufügen und wählen Sie den Typ Forgejo.
- Tragen Sie Ziel-URL, Geheimnis und die gewünschten Ereignisse ein.
- Speichern Sie und prüfen Sie den Empfang mit Zustellung testen.
Webhooks lassen sich auch für eine Organisation oder Ihr Konto anlegen.
Mit dem Geheimnis prüfen Sie die Herkunft: Der Header X-Forgejo-Signature enthält eine HMAC-SHA256-Signatur des Inhalts. Das Ereignis steht in X-Forgejo-Event.