API-Einstellungen

Auf der Seite API-Einstellungen können Sie Ihre API-Anmeldedaten verwalten, Webhooks konfigurieren und das Verhalten der SMS API steuern. Jeder API-Schlüssel verfügt über einen eigenen Satz von Anmeldeinformationen und Konfigurationen.

Zugriff auf API-Einstellungen

1. Melden Sie sich bei Ihrem Vonage Dashboard an
2. Navigieren Sie zu Einstellungen → API-Einstellungen in der linken Seitenleiste.
3. Wählen Sie oben einen API-Schlüssel aus.

Sobald Sie einen API-Schlüssel ausgewählt haben,

API-Schlüssel und Geheimnis

Ihr API-Schlüssel wird oben auf der Seite im Dropdown-Menü für den Account angezeigt. Dies ist eine öffentliche Kennung, die bei API-Anfragen verwendet wird. Sie können ihm auch einen Spitznamen geben, um es auf der Plattform zu identifizieren (z. B. "Produktion", "Entwicklung", "Test").

Ihr API-Geheimnisse sind in der API-Schlüssel Geheimnis Abschnitt:

• API-Geheimnis 1 - Ihr primäres Authentifizierungsgeheimnis (standardmäßig maskiert)
• API-Geheimnis 2 - Ihr sekundäres Geheimnis für die Rotation (standardmäßig ausgeblendet)

Wenn Sie noch kein zweites API-Geheimnis haben, können Sie hier eines erstellen, indem Sie auf den Link "Neues Geheimnis erstellen" klicken.

Messaging API-Typ

Legen Sie fest, wie Vonage SMS-Nachrichten für diesen API-Schlüssel behandelt.

Vonage verfügt über zwei verschiedene APIs für den Versand von SMS. Sie können immer nur eine davon verwenden, da sie das Format der empfangenen Webhooks ändert.

Wählen Sie Ihre API:

• SMS API - Legacy-API mit einfacherem Webhook-Format (GET oder POST)
• Messages API - Moderne Multi-Channel-API mit JSON-Webhooks

Klicken Sie auf die entsprechende Schaltfläche, um auszuwählen, welche API Sie verwenden möchten.

SMS API

Webhook-Format

Nur für SMS APIWählen Sie das Format für die Webhooks für den Lieferschein (DLR):

1. Klicken Sie auf die Webhook-Format Dropdown.
2. Wählen Sie aus:
   • GET - Webhook-Daten, die als URL-Abfrageparameter gesendet werden
   • POST - Webhook-Daten werden als formularcodierter Körper gesendet
   • POST-JSON - Webhook-Daten werden als JSON-Body gesendet (empfohlen)

Lieferscheine (DLR) Webhooks

Erhalten Sie Aktualisierungen des Zustellungsstatus für ausgehende SMS-Nachrichten.

1. In der Webhooks für Lieferscheine (DLR) geben Sie Ihre Webhook-URL ein.
2. Beispiel: https://example.com/webhooks/delivery-receipt
3. Wenn eine SMS zugestellt wird (oder fehlschlägt), sendet Vonage eine Aktualisierung an diese URL.

Details zu den Webhook-Nutzdaten finden Sie in der SMS API Webhooks-Referenz.

Eingehende SMS-Webhooks

Erhalten Sie Benachrichtigungen, wenn jemand eine SMS an Ihre Vonage-Nummer sendet.

1. In der Eingehende SMS-Webhooks geben Sie Ihre Webhook-URL ein.
2. Beispiel: https://example.com/webhooks/inbound-sms
3. Wenn jemand eine SMS an Ihre Vonage-Nummer sendet, wird die Nachricht an diese URL weitergeleitet.

Details zu den Webhook-Nutzdaten finden Sie in der SMS API-Referenz für eingehende Nachrichten.

Messages API

Status Webhooks

Erhalten Sie Statusaktualisierungen für ausgehende Nachrichten.

1. In der Status-Webhooks geben Sie Ihre Webhook-URL ein.
2. Beispiel: https://example.com/webhooks/status-updates
3. Wenn sich der Status einer von Ihnen gesendeten Nachricht ändert, sendet Vonage eine Aktualisierung an diese URL.

Details zu den Webhook-Nutzdaten finden Sie in der Messages API Webhooks-Referenz.

Eingehende Webhooks

Erhalten Sie Benachrichtigungen, wenn ein Kunde eine Nachricht an Sie sendet.

1. In der Eingehende Webhooks geben Sie Ihre Webhook-URL ein.
2. Beispiel: https://example.com/webhooks/inbound-message
3. Wenn Ihnen jemand über einen Ihrer Messages API-Kanäle eine Nachricht sendet, wird die Nachricht an diese URL weitergeleitet.

Details zu den Webhook-Nutzdaten finden Sie in der Messages API Referenz für eingehende Nachrichten.

Signierte Webhooks

Fügen Sie eine optionale Sicherheitsebene hinzu, um zu verifizieren, dass die Webhook-Anfragen von Vonage stammen und während der Übertragung nicht manipuliert wurden.

Unterschrift Geheimnis

Ein geheimer Schlüssel, der zur Erzeugung der in Webhook-Anfragen enthaltenen Signatur verwendet wird.

1. In der Signierte Webhooks Abschnitt, sehen Sie Ihre Unterschriftsgeheimnis (standardmäßig maskiert).
2. Klicken Sie auf die Augen-Symbol um das Geheimnis zu lüften.
3. Klicken Sie auf die Kopiersymbol um sie in die Zwischenablage zu kopieren.

Unterschrift Methode

Wählen Sie den Algorithmus, der zur Erstellung der Webhook-Signatur verwendet wird:

1. Klicken Sie auf die Methode der Unterschrift Dropdown.
2. Wählen Sie aus:
   • MD5-HASH-Signatur (veraltet, nicht empfohlen)
   • MD5-HMAC-Signatur
   • SHA1-HMAC-Signatur
   • SHA-256 HMAC-Signatur (empfohlen)
   • SHA-512 HMAC-Signatur (am sichersten)

Wenn diese Funktion aktiviert ist, enthalten eingehende Webhook-Anfragen ein JWT-Token im Autorisierungs-Header, das mit Ihrem Signaturgeheimnis signiert ist. Erfahren Sie mehr über Validierung signierter Webhooks.

Einhaltung der Vorschriften

HIPAA-Nummern

Wenn Ihr Account für den Kauf von HIPAA-konformen Numbers freigeschaltet wurde, sehen Sie den folgenden Hinweis:

Wenden Sie sich an Ihren Vonage Account Manager, wenn Sie die HIPAA-Konformität für Ihren Anwendungsfall aktivieren müssen.