Konfiguration
Konfigurieren Sie das Ziel und die Abonnements Ihrer Organisation über die Platform oder API.
Jede Organisation hat ein Webhook-Ziel und ein aktives signing secret (Signaturschlüssel). Konfigurieren Sie es in der Platform oder von Ihrem Server aus.
| Detail | Wert |
|---|---|
| Basis-URL | https://api.sandbox.tapaya.com für die Sandbox, https://api.tapaya.com für die Produktion |
| Authentifizierung | Server Secret Token in Authorization. Siehe Authentifizierung. |
| Geltungsbereich | Ein Ziel pro Organisation |
| Zugehöriger Leitfaden | Verifizieren und testen |
In der Platform konfigurieren
Öffnen Sie API Keys für Ihre Organisation und suchen Sie Webhooks.
- Geben Sie Ihre öffentliche HTTPS-URL ein.
- Wählen Sie die benötigten Ereignisse aus oder aktivieren Sie Subscribe to all webhook types.
- Aktivieren Sie Enable und klicken Sie auf Save.
- Kopieren Sie das signing secret und speichern Sie es auf Ihrem Server.
- Senden Sie einen Test-Webhook.
Das signing secret wird nur einmal angezeigt
Kopieren Sie es, wenn Sie das Ziel erstellen oder den Schlüssel rotieren; es kann später nicht mehr abgerufen werden. Es verifiziert nur eingehende Webhooks. Ihr Server Secret Token autorisiert Konfigurationsanfragen.
Alle Operationen
| Operation | Zweck |
|---|---|
| Ziel speichern | Das aktuelle Abonnement erstellen oder ersetzen oder sein signing secret rotieren. |
| Ziel lesen | Die aktuelle URL, den Abonnementmodus und den Aktivierungszustand abrufen. |
| Ziel löschen | Das Abonnement sowie seine Zustellwarteschlange und seinen Zustellverlauf entfernen. |
Ziel verwalten
Zielregeln
Einstellungen ändern
| Wenn Sie | Was passiert |
|---|---|
| Die URL, die Ereignisse oder den Schlüssel ändern | Neue Ereignisse verwenden die neuen Einstellungen. Ereignisse in der Warteschlange behalten die alte URL und den alten Schlüssel; halten Sie daher beide funktionsfähig, bis die Warteschlange abgearbeitet ist. |
| Webhooks deaktivieren | Zustellungen aus der Warteschlange werden pausiert und keine neuen Ereignisse festgehalten. Die erneute Aktivierung setzt die Warteschlange fort, aber verpasste Änderungen werden nicht nachträglich bereitgestellt. Tests funktionieren weiterhin. |
| Das Ziel löschen | Ereignisse in der Warteschlange und der Zustellverlauf werden entfernt. Eine bereits laufende Anfrage kann noch eintreffen. Das erneute Erstellen erzeugt ein neues signing secret. |
URL-Anforderungen
- Öffentliches HTTPS auf Port 443. Localhost und private Netzwerke werden zurückgewiesen, und DNS wird bei jedem Verbindungsaufbau erneut geprüft.
- Keine eingebetteten Zugangsdaten, kein Fragment und keine Weiterleitungen.
- Keine benutzerdefinierten Autorisierungsheader. Verifizieren Sie stattdessen die Tapaya-Signatur oder schalten Sie einen serverseitigen Adapter vor eine URL, die einen eigenen Schlüssel benötigt.
Fehler
Konfigurationsanfragen schlagen mit diesen Antworten fehl. Ein Empfänger, der eine Zustellung zurückweist oder verpasst, ist ein anderes Problem; siehe Fehler behandeln.
| Antwort | Bedeutung |
|---|---|
400 bei PUT | Ungültige URL, nicht unterstützter Ereignistyp, fehlendes erforderliches Feld oder leere explizite Ereignisauswahl. |
401 | Das Server Secret Token fehlt oder ist ungültig. |
404 bei GET | Für die authentifizierte Organisation ist kein Ziel vorhanden. |
Fahren Sie mit der Signaturprüfung und Testzustellung fort.
Fehlt Ihnen etwas auf dieser Seite?Wünschen Sie sich eine Funktion. Wir hängen diese Seite an, damit das Team den Kontext sieht.