Postbote

Unsere APIs können mit jedem HTTP-Client verwendet werden; wählen Sie Ihren Favoriten! Wir lieben Postboteist eine benutzerfreundliche grafische Oberfläche für einen leistungsstarken plattformübergreifenden HTTP-Client.

Probieren Sie unsere "run in Postman"-Schaltfläche aus, um einen schnellen Einstieg in unsere meistgenutzten APIs zu erhalten:

Wenn Sie eine unserer Beta- oder Developer Preview-APIs benötigen, lesen Sie weiter, um zu erfahren, wie Sie die OpenAPI-Dokumente auf den API-Referenzseiten mit Postman verwenden können.

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.

Abrufen der OpenAPI-Beschreibung der API

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. Die Dateien sind in .yml Format.

Spezifikation in Postman importieren

Starten Sie Postman und suchen Sie die Schaltfläche "Importieren" in der linken Leiste. Suchen Sie nach dem .yml Datei, die Sie verwenden möchten, und wählen Sie "Öffnen" und dann "Weiter".

In der linken Seitenleiste finden Sie nun einen Ordner/Sammlung für Ihre API und darin eine Vorlagenanforderung für jeden der Endpunkte in der API.

Einen API-Aufruf tätigen

Wenn Sie beispielsweise die Verify-API-Beschreibung importiert haben, können Sie in der linken Leiste die Option "Verify Request" auswählen und erhalten eine fertige Anfrage, die Sie verwenden können. Fügen Sie nun die benötigten Felder hinzu:

• Ihre API-Anmeldedaten! Für Verify API ist das die API_KEY und API_SECRET und Sie finden diese Angaben in Ihrem Account-Dashboard
• Die zu verifizierende Telefonnummer (denken Sie daran, das E.164-Format zu verwenden)
• Der Name der Marke, die die Verifizierung durchführt (Sie können hier alles wählen, da Sie nur Dinge testen)
• Setzen Sie die format Wert im Abschnitt Pfadparameter auf json

Drücken Sie nun auf "Senden" und prüfen Sie die Antwort der API.

Erweiterte Verwendung von Postman

Da wir große Fans von Postman sind, möchten wir unsere besten Tipps mit Ihnen teilen.

Umgebungen verwenden

Postman hat ein Funktion "Umgebungen die sehr nützlich ist, wenn Sie dieselben Variablen (z. B. Ihre API-Anmeldedaten) in vielen verschiedenen Anfragen 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

Speichern Sie die Werte und geben Sie dann in Ihrer Anfrage statt des API-Schlüssels Folgendes ein {{api_key}} und 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.