Arbeiten mit Vonage APIs

Willkommen auf der Vonage API-Plattform! Vonage bietet eine Reihe von APIs, die es Ihnen ermöglichen, mit Ihren Kunden über Ihre bevorzugten Kanäle zu kommunizieren.

Auf dieser Website finden Sie eine umfassende Dokumentation für alle unsere APIs. Alles, was Sie über die Arbeit mit einer bestimmten API wissen müssen, finden Sie in dem entsprechenden Abschnitt.

Es gibt jedoch einige grundlegende Concepts, die Sie verstehen müssen, und Tools, die Ihnen helfen können, die für alle unsere APIs gelten:

Anmeldung für einen Account

Um mit unseren APIs zu arbeiten, müssen Sie sich für einen Account anmelden. Dadurch erhalten Sie einen API-Schlüssel und ein Geheimnis, das Sie für den Zugriff auf unsere APIs verwenden können.

Zugriff auf das Dashboard für Entwickler

Sobald Sie einen Account haben, können Sie sich in der Dashboard für Entwickler. Das Developer Dashboard ist ein GUI-basierter Ansatz für die Verwaltung Ihres Accounts, über den Sie Ihr Konto verwalten können:

  • Ihren API-Schlüssel und Ihr Geheimnis anzeigen. Sie benötigen diese, um Ihre Anfragen an unsere APIs zu authentifizieren
  • Verwalten Sie Ihren Account-Saldo. Der Zugang zu unseren APIs wird pro Anfrage berechnet. Bei der Eröffnung Ihres Accounts erhalten Sie ein kostenloses Guthaben, und Sie können aufstocken wenn sie knapp werden.
  • Virtuelle Numbers mieten. Sie können verwenden virtuelle Numbers von Vonage zum Senden und Empfangen von Anrufen und Nachrichten. Siehe eine virtuelle Nummer mieten.
  • Verwalten von Applications. Für einige unserer APIs (z. B. Voice und Messages API) müssen Sie eine Applikationdie als Container für Sicherheits- und Konfigurationsinformationen dient. Sie können diese Applications im Developer Dashboard erstellen und verwalten.
  • Verwalten Sie Ihren Account. Sie können durchführen andere Verwaltungsaufgaben hier.

Verwenden der Vonage CLI

Optional können Sie viele der Dashboard-Aufgaben über die Befehlszeile ausführen, indem Sie die Vonage CLI verwenden. Dies ist oft schneller und ermöglicht es Ihnen auch, diese Vorgänge zu skripten.

Die Vonage CLI ist mit oclif und kann mit dem Node Package Manager installiert werden (npm). Die Website README im Vonage CLI GitHub Repo zeigt Ihnen, wie Sie die Vonage CLI installieren und mit ihr arbeiten.

Authentifizierung

Wenn Sie die Vonage APIs verwenden, müssen Ihre Anfragen authentifiziert. Dies geschieht in der Regel durch Grundlegende Authentifizierung oder JWTs. Sie können ein geeignetes JWT mithilfe der Vonage CLI oder unserer Online-Tool. Während Grundlegende Authentifizierung funktioniert, erlaubt es Ihnen aber nicht, Webhooks zu empfangen - diese können nur aktiviert werden, indem Sie JWTs.

Wenn Sie die stille Authentifizierung mit Verify verwenden, muss es sich um den ersten Kanal im Array der Workflows handeln.

Experimentieren mit unseren APIs

Letztendlich werden Sie eine App in Ihrem Unternehmen erstellen wollen. gewählte Programmiersprache. Für den Anfang sollten Sie jedoch einige Beispielanfragen an unsere APIs stellen, um zu prüfen, ob Sie die richtigen Parameter angegeben haben und die gewünschten Antworten zurückerhalten.

Wenn Sie mit dem Befehlszeilentool vertraut sind Lockefinden Sie Curl-Snippets für jede unserer APIs, die Sie kopieren, einfügen und ändern können.

Postbote

Es gibt verschiedene GUI-Tools, die einfacher zu benutzen sind als Curl. Ein beliebtes Tool ist Postbote. Lesen Sie unseren Leitfaden über Verwendung von Postman für die Arbeit mit unseren APIs. Vonage bietet auch eine Reihe von Postboten-Sammlungendie eine Möglichkeit bietet, die APIs sofort zu nutzen.

OpenAPI

Jede unserer APIs hat ihre eigene OpenAPI-Spezifikation. Mehr über OpenAPI können Sie in unserem Dokumentation. Unsere Spezifikationen entsprechen der OpenAPI-Spezifikation Version 3, auch bekannt als OAS3.

Verwendung eines Server-SDKs

Wenn Sie mit der Entwicklung Ihrer Anwendung beginnen möchten, sollten Sie eines unserer Server-SDKs verwenden, anstatt jede Anfrage von Hand zu kodieren. Sie finden Links zu allen unseren SDKs auf der Werkzeuge Seite.

Arbeiten mit Webhooks

Sobald Sie gelernt haben, wie Sie Anfragen an unsere APIs stellen, um Anrufe zu tätigen, Nachrichten zu senden usw., möchten Sie lernen, wie Sie eingehende Mitteilungen über Ihre virtuelle Nummer empfangen können.

Wenn unsere APIs Ihre Anwendung über etwas benachrichtigen wollen - sei es ein eingehender Anruf, eine Nachricht oder eine Statusaktualisierung - muss Ihre Anwendung einen URL-Endpunkt bereitstellen, an den unsere Plattform eine Anfrage stellen kann. Diese müssen über das öffentliche Internet zugänglich sein.

Diese Endpunkte werden als Webhooks bezeichnet. Erfahren Sie mehr über Webhooks. Sobald Sie Ihren Web-Hook erstellt haben, müssen Sie unserer API-Plattform mitteilen, dass sie ihn verwenden soll. Wie Sie dies tun, hängt davon ab, welche API Sie verwenden. Eine vollständige Anleitung finden Sie in der Dokumentation der jeweiligen API.

Diese Webhooks während der Entwicklung öffentlich zugänglich zu machen, kann schwierig sein, daher empfehlen wir das Tool Ngrok.

Besuchen Sie unseren Leitfaden auf Testen mit Ngrok um zu lernen, wie man es benutzt.

Numbers Format

Innerhalb der Vonage APIs sind alle Telefonnummern in E.164-Format. Dies bedeutet, dass Numbers:

  • Lassen Sie sowohl ein führendes + und die internationale Vorwahl wie 00 oder 001.
  • Sie dürfen keine Sonderzeichen, wie z. B. ein Leerzeichen, enthalten, () oder -

Eine US-Nummer hat zum Beispiel das Format 14155550101. Eine britische Nummer hat das Format 447700900123.

Wenn Sie sich nicht sicher sind, wie Sie die Nummer formatieren sollen, können Sie die Number Insight API kann verwendet werden, um korrekte Informationen über eine Zahl zu finden.

Siehe auch Numbers-Format in der Voice API-Dokumentation.

Concepts

Es gibt eine Reihe gemeinsamer Concepts zwischen den Vonage APIs: die Verwendung von JSON Web Tokens (JWTs), signierte Anfragen und Webhooks. In den folgenden Anleitungen wird die Verwendung dieser Elemente im Detail erläutert.

  • Applications - Sicherheits- und Konfigurationsinformationen, die Sie für die Verbindung mit Vonage-Endpunkten benötigen.
  • Authentifizierung - API-Schlüssel und JSON-Web-Token (JWTs).
  • Signieren von Nachrichten - wie man Nachrichten kryptografisch signiert und Nachrichtensignaturen verifiziert.
  • Webhaken - Die API von Vonage kann Daten über einen Webhook an Ihren Webserver zurücksenden.
  • OpenAPI - Alle Vonage-APIs verfügen über OpenAPI-Beschreibungen, die Sie in Ihrem eigenen Entwicklungsprozess nutzen können.
  • Glossar - Ein Glossar mit allgemeinen Begriffen, die auf der Vonage Plattform verwendet werden.

Was ist als nächstes zu tun?

In diesem Leitfaden werden einige der grundlegenden Konzepte und Tools vorgestellt, die Sie bei der Arbeit mit unseren APIs kennen sollten.

Wenn Sie diese grundlegenden Concepts verstanden und die Tools, die Sie verwenden wollen, installiert haben, können Sie mit dem Bauen beginnen! Ansicht der Dokumentation für die von Ihnen gewählte API um loszulegen.

Sollten Sie auf Schwierigkeiten stoßen, lesen Sie bitte unsere Gemeinschaft Slackoder werfen Sie einen Blick in unsere Wissensdatenbank und wenden Sie sich bei Bedarf an folgende Adresse unsere Supportseite.