API-Zugriff und Webhooks sicher einrichten
Erstellen Sie einen gezielt berechtigten Zugriff und senden Sie nur ausgewählte Ereignisse an eine HTTPS-Adresse.
Das erreichen Sie
Die Integration besitzt den kleinstmöglichen Zugriff und jeder Zustellversuch ist nachvollziehbar.
Schritt für Schritt
- 1
Öffnen Sie „Webhooks“ oder die API-Token-Verwaltung und wählen Sie „Endpoint erstellen“.
- Woran Sie richtig sind
- Suchen Sie nach „Endpoint erstellen“.
- Danach sehen Sie
- Name, URL, Events und Secret können geprüft werden.
- Datenwirkung
- Noch kein Zugriff.
- 2
Tragen Sie eine HTTPS-URL ein, wählen Sie nur nötige Events und speichern Sie das Secret sicher.
- Woran Sie richtig sind
- Suchen Sie nach „Speichern“.
- Danach sehen Sie
- Der aktive Endpunkt erscheint in der Liste.
- Datenwirkung
- Ein Webhook-Endpunkt und Signatur-Secret werden gespeichert.
- 3
Prüfen Sie eine Testzustellung im Auslieferungsverlauf.
- Woran Sie richtig sind
- Suchen Sie nach „Auslieferungen“.
- Danach sehen Sie
- Status und Antwortcode sind sichtbar.
- Datenwirkung
- Ein Zustellprotokoll wird gespeichert.
Durchgängiges Beispiel
Ein HTTPS-Testendpunkt erhält nur „Invoice created“. Das Signatur-Secret wird einmal sicher gespeichert und nicht in Tickets kopiert.
Wenn etwas nicht klappt
„Endpoint erstellen“ oder die beschriebene Aktion ist nicht sichtbar.
Mögliche Ursachen
- Der Funktionsbereich ist ausgeschaltet.
- Ihre Rolle besitzt nicht die benötigte Berechtigung.
- Die falsche Firma ist ausgewählt.
Sichere Lösung
- Prüfen Sie oben rechts die ausgewählte Firma.
- Bitten Sie den Kontoinhaber, den Bereich unter „Funktionen“ und Ihre Gruppe zu prüfen.
- Laden Sie die Seite danach neu und wiederholen Sie nur den noch nicht gespeicherten Schritt.
Reparatur erkannt: „Endpoint erstellen“ ist sichtbar und der erwartete Zustand kann ohne Umgehung geöffnet werden.
Datensicherheit: Bis zur sichtbaren Speicher- oder Sende-Bestätigung wurde keine Fachaktion ausgeführt.
Wenn es weiter nicht klappt: Wenn Rechte und Funktion stimmen, notieren Sie Seite, Uhrzeit und sichtbare Fehlermeldung für den Support – niemals Zugangsdaten.
Ergebnis prüfen
Der Endpunkt ist aktiv, eine Testzustellung hat erwarteten Status und das Secret wird nicht mehr offen angezeigt.
Datenwirkung und Rückweg
- Was verändert wird
- API-Token oder Webhook-Endpunkt gewährt technischen Zugriff beziehungsweise versendet Ereignisdaten.
- So korrigieren Sie es
- Deaktivieren oder widerrufen Sie Token und Endpunkt; rotieren Sie ein offengelegtes Secret sofort.