Erste Schritte mit Vonage CLI

Die Vonage-Befehlszeilenschnittstelle verfügt über zahlreiche Befehle, die mit den APIs von Vonage verwendet werden können. Sie können das Dashboard verwenden, um viele Sie können viele CLI-Aufgaben über das Dashboard erledigen, aber Sie können Ihre Anwendung auch programmatisch auf Ihrem Server einrichten und konfigurieren. Haben Sie bereits eine Vonage-Anwendung konfiguriert? Mit der CLI können Sie die Konfiguration schnell in JSON oder YAML exportieren, um sie in Ihrem Programm zu verwenden. Programm zu verwenden.

Was ist neu in Version 3

Wer neu in der CLI ist, kann diesen Abschnitt überspringen. Die neueste Version 3 der CLI bietet ein grundlegendes, pragmatisches Design, um einige der Unzulänglichkeiten früherer Versionen zu beheben.

Standardisierte Flaggen

Alle Flags in der Vonage CLI verwenden jetzt Kebab-KofferDadurch wird die Konsistenz gewährleistet und die Befehle sind einfacher.

Unterstützung von JSON und YAML Output

Sie können jetzt das Ausgabeformat von Befehlen mit JSON oder YAML angeben, was eine flexible Integration mit Ihren Werkzeuge und Arbeitsabläufe.

Gruppierte Befehle nach Aktion

Die Befehle sind nach Aktionen geordnet, um die Benutzerfreundlichkeit zu erhöhen und die Suche nach den benötigten Funktionen zu erleichtern.

Gebaut mit yargs

Die Version 3 wurde von Grund auf mit Hilfe der yargs Link Paket, das eine robuste und benutzerfreundliche benutzerfreundliche Erfahrung.

Leichtere Konfiguration

Die Konfiguration der CLI wurde vereinfacht, um die Arbeit innerhalb einer Vonage Anwendung oder eines Vonage Accounts zu erleichtern. Siehe unten für weitere Informationen über die Konfiguration der CLI

Automatische Aktualisierungen

Version 3 sucht regelmäßig nach neuen Aktualisierungen und informiert Sie, wenn ein Upgrade erforderlich ist. So wird sichergestellt, dass Sie dass Sie die Vonage APIs korrekt aufrufen und dass das Tool fehlerfrei ist.

Einrichtung

Die Vonage CLI ist mit NodeJS und nutzt die @vonage/server-sdk Link Paket. Die CLI arbeitet immer mit dem niedrigsten Long Term unterstützten (LTS) Version von NodeJS (derzeit 18.20).

Installieren mit npm

So installieren Sie die Vonage CLI mit npmführen Sie den folgenden Befehl aus:

npm install -g @vonage/cli

Verlegung mit Garn

So installieren Sie die Vonage CLI mit yarn,

yarn global add @vonage/cli

Globale Flaggen

Die Vonage CLI bietet eine Reihe von globalen Flags, die für alle Befehle verfügbar sind:

  • --verbose: Drucken Sie weitere Informationen.
  • --debug: Debug-Informationen drucken.
  • --no-color: Schaltet die Farbausgabe aus.
  • --help: Hilfe anzeigen.

verbose und debug Informationen werden geschrieben an STDERR um die Ausgabe in andere Programme zu ermöglichen

Authentifizierung

Die Vonage CLI verwendet ein flexibles Konfigurationssystem zur Verwaltung Ihrer API-Anmeldeinformationen. Es unterstützt lokale oder globale Konfigurationsdateien und Befehlszeilen-Flags, um diese Werte zu überschreiben, so dass Sie Ihr Setup je nach Projektanforderungen oder persönlichen Vorlieben anpassen.

Konfiguration

Die CLI lädt die Konfiguration in der folgenden Reihenfolge:

  1. Befehlszeilen-Flags --api-key, --api-secret, --private-keyund --app-id.
  2. Eine lokale Konfigurationsdatei im aktuellen Arbeitsverzeichnis .vonagerc.
  3. Eine globale Konfigurationsdatei in der .vonage Ordner in Ihrem Heimatverzeichnis $HOME/.vonage/config.json.

Anmerkung: Nur die CLI liest diese Werte aus .vonagerc. Die Vonage SDKs erfordern eine separate Initialisierung mit seinen eigenen Anmeldeinformationen.

Hinweis: Der Inhalt des privaten Schlüssels wird in der Konfigurationsdatei gespeichert. Dies soll dazu dienen dass der Schlüssel nicht überschrieben wird, wenn neue Schlüssel erzeugt werden

Flaggen:

  • --api-key: Der API-Schlüssel, den Sie im Abschnitt "API-Einstellungen" Ihres Dashboards finden.
  • --api-secret: Das API-Geheimnis, das Sie im Abschnitt "API-Einstellungen" in Ihrem Dashboard finden.
  • --app-id: Die ID der zu verwendenden Applikation. Sie finden diese im Abschnitt "Applications" des Dashboards oder wird ausgegeben mit vonage apps.
  • --private-key: Der Pfad oder Inhalt des privaten Schlüssels. Der Zugriff auf den privaten Schlüssel ist nur möglich, wenn die Anwendung erstellt wird oder wenn Sie die Schlüssel im Dashboard neu generieren.

Authentifizierung einstellen

Sie können die Befehlszeilenschnittstelle (CLI) zwar auch ohne Konfiguration verwenden, müssen aber die Flags angeben, wenn Sie einen Befehl ausführen. Die Verwendung der vonage auth set wird empfohlen, damit Sie sie nicht jedes Mal eingeben müssen, wenn Sie einen Befehl ausführen.

Flaggen:

Dieser Befehl verwendet die globale Authentifizierungskennzeichen

Beispiele:

Konfigurieren Sie Ihre Vonage-API-Anmeldedaten:

vonage auth set `
--api-key='your-api-key' `
--api-secret='your-api-secret' `
--app-id='your-application-id' `
--private-key=C:\path\to\private.key

API Key: your-api-key
API Secret: your-**************
App ID: your-application-id
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

Hinweis: Laufen vonage auth set werden die aktuellen Werte nicht entfernt. Daher können Sie nur den API-Schlüssel/Geheimnis oder die App-ID/Privater Schlüssel einzeln festlegen. Sie können jedoch die App-ID und den privaten Schlüssel nicht einstellen, wenn Sie nicht ohne den API-Schlüssel und das Geheimnis gesetzt zu haben. Dies liegt daran, wie der Befehl die Gültigkeit der Anmeldeinformationen überprüft.

Hinweis: Mit diesem Befehl wird auch geprüft, ob die Anmeldedaten korrekt sind, bevor sie übertragen werden.

Authentifizierung prüfen

Überprüfen Sie, ob Ihre Authentifizierungsdaten gültig sind. Standardmäßig wird dazu die globale Konfigurationsdatei verwendet. Die Überprüfung von der Anmeldeinformationen funktioniert wie folgt:

  1. Der API-Schlüssel und das Geheimnis werden durch einen Aufruf zur Auflistung der Applications mit der Funktion Applications API.
  2. Die App-ID und der private Schlüssel werden validiert, indem die Anwendungsinformationen abgerufen werden und der öffentliche Schlüssel zusammen mit dem privaten Schlüssel verwendet wird, um sicherzustellen, dass sie korrekt gepaart sind.

Hinweis: Dieser Befehl verwendet keine Befehlszeilenargumente. Er prüft nur die Konfigurationsdateien

Flaggen:

  • --local: Verwenden Sie die lokale Konfigurationsdatei (.vonagerc).

Beispiele:

Überprüfen Sie die globale Konfiguration:

vonage auth check 

Global credentials found at: C:\Users\bob\.vonage\config.json

API Key: abcd1234
API Secret: abc**************
App ID: 00000000-0000-0000-0000-000000000000
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

Überprüfen Sie die lokale Konfiguration:

vonage auth check --local

Global credentials found at: .vonagerc

API Key: abcd1234
API Secret: abc**************
App ID: 00000000-0000-0000-0000-000000000000
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

Authentifizierung anzeigen

Zeigen Sie Ihre aktuelle Authentifizierungskonfiguration an. Dies erfolgt nach dem Laden der erwähnten Konfiguration über und teilt Ihnen mit, welche Konfigurationsdatei die CLI verwendet.

Hinweis: Mit diesem Befehl wird auch geprüft, ob die Anmeldedaten korrekt sind.

Flaggen:

  • --show-all: Nicht redigierten privaten Schlüssel und API-Geheimnis anzeigen.
  • --yaml: Ausgabe im YAML-Format.
  • --json: Ausgabe im JSON-Format.

Beispiele:

Anzeigen der Konfiguration

vonage auth show

Global credentials found at: C:\Users\bob\.vonage\config.json

API Key: your-api-key
API Secret: your-**************
App ID: your-application-id
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

Verwendung der CLI

Verfügbare Befehle anzeigen

Die Befehle sind nach Produkt oder Aktion gruppiert. Um eine Liste der verfügbaren Befehle anzuzeigen, führen Sie einfach Folgendes aus vonage ohne jegliche Argumente:

vonage 

vonage <command>

Commands:
  vonage apps [command]           Manage applications
  vonage auth [command]           Manage authentication information
  vonage balance                  Check your account balance
  vonage conversations [command]  Manage conversations
  vonage jwt <command>            Manage JWT tokens
  vonage members [command]        Manage applications
  vonage numbers [command]        Manage numbers
  vonage users [command]          Manage users

Options:
      --version   Show version number                                                                                                                                                  [boolean]
  -v, --verbose   Print more information                                                                                                                                               [boolean]
  -d, --debug     Print debug information                                                                                                                                              [boolean]
      --no-color  Toggle color output off                                                                                                                                              [boolean]
  -h, --help      Show help                                                                                                                                                            [boolean]

Brauchen Sie Hilfe?

Wenn Sie Probleme haben oder Hilfe benötigen, treten Sie bitte unserem Slack-Kanal der Gemeinschaft.