Postbote

Unsere APIs können mit jedem HTTP-Client verwendet werden; wir empfehlen jedoch Postboteeine benutzerfreundliche grafische Oberfläche für einen leistungsstarken plattformübergreifenden HTTP-Client.

Vonage hat eine Postman-Sammlung erstellt, die Ihnen einen schnellen Einstieg in unsere am häufigsten verwendeten APIs ermöglicht. Der Arbeitsbereich ist nach Fähigkeiten strukturiert, so dass Sie die gesuchte API leicht finden können. Außerdem enthält er vollständig dokumentierte Anfragen. Auf der Registerkarte "Beschreibung" für jede Anfrage finden Sie eine Dokumentation, in der erklärt wird, was der Aufruf bewirkt, wann Sie ihn verwenden, welche Variablen erforderlich sind (API-Schlüssel, Geheimnisse, JWTs) und welche Antworten erwartet werden.

Klicken Sie auf die Schaltfläche "Run in Postman", um den Arbeitsbereich in Ihrer eigenen Postman-Umgebung zu forken und die Sammlung zu testen:

Sie können unsere OpenAPI-Spezifikationen auch direkt herunterladen und importieren, indem Sie die nachstehenden Anweisungen befolgen.

Postman und OpenAPI

Postman unterstützt die OpenAPI-Dokumente, die wir mit allen unseren APIs veröffentlichen.

Installieren Sie Postman und befolgen Sie die unten aufgeführten Schritte, um eine der Vonage-APIs sehr schnell auszuprobieren. Wir veröffentlichen ein OpenAPI-Dokument für jede API, und Postman kann diese lesen und eine Sammlung von Anfragen erstellen, in die Sie Werte eingeben können.

Herunterladen und Importieren der OpenAPI-Spezifikation

Am einfachsten finden Sie das OpenAPI-Dokument, indem Sie auf die Schaltfläche "OpenAPI 3-Spezifikation herunterladen" auf der API-Referenz für die API klicken, die Sie ausprobieren möchten. Besuchen Sie zum Beispiel die API-Referenzseite verifizieren und klicken Sie auf die Schaltfläche Herunterladen. Sie können es herunterladen in .yml oder .json Format.

Sie können dann folgen diese Anleitungen um die Datei in Postman zu importieren.

Einen API-Aufruf tätigen

Nach dem Import können Sie die verschiedenen Endpunkte sehen, die für die API verfügbar sind. Wenn Sie beispielsweise die Verify-API-Beschreibung importiert haben, können Sie in der linken Navigationsleiste die Option "Anforderung einer Verifizierung an einen Benutzer" auswählen und erhalten eine fertige Anfrage zur Verwendung. Sobald Sie die Kopfzeilen und den Textkörper mit den erforderlichen Informationen aktualisiert haben, können Sie auf "Senden" klicken und die Antwort der API überprüfen.

Erweiterte Verwendung von Postman

Umgebungen verwenden

Postman hat ein Funktion "Umgebungen die es Ihnen ermöglicht, dieselben Variablen (wie z. B. Ihre API-Anmeldedaten) in vielen verschiedenen Anfragen zu verwenden.

Um eine Umgebung zu erstellen, klicken Sie auf das Einstellungssymbol oben rechts auf dem Bildschirm und wählen Sie "Hinzufügen". Geben Sie Ihrer Umgebung einen Namen und fügen Sie alle Variablen hinzu, die Sie verwenden möchten, z. B.:

• api_key
• api_secret
• phone_number

Einmal gespeichert, können Sie zum Beispiel Folgendes eingeben {{api_key}} in Ihren Anfragen verwenden, anstatt Ihren API-Schlüssel einzufügen. Postman wird den Wert aus der aktuellen Umgebung verwenden.

Sie können mehrere Umgebungen haben, was nützlich ist, wenn Sie verschiedene Schlüssel für verschiedene Dinge verwenden, oder wenn Sie API-Anforderungen an ein Debugging-Tool oder einen API-Mocking-Server wie Prism senden. Fügen Sie so viele Umgebungen wie nötig hinzu, indem Sie die obigen Schritte wiederholen und die zu verwendende Umgebung aus dem Dropdown-Menü oben rechts auf dem Bildschirm auswählen.

Postboten-Sammlungen

Informationen über Postman-Sammlungen finden Sie in der Postboten-Sammlungen Dokumentation.