Travailler au niveau local

Le Code Hub peut être utilisé entièrement à partir de la ligne de commande en utilisant le CLI si vous préférez utiliser vos propres outils pour travailler localement.

Pour déployer une application directement à partir du navigateur sans outil local, voir notre guide sur les travailler dans le nuage.

Installation du CLI

Code Hub peut être utilisé entièrement à partir de la ligne de commande ; vcr est l'interface de ligne de commande nécessaire pour gérer et déployer vos Applications à partir du terminal.

pwsh -Command "iwr https://raw.githubusercontent.com/Vonage/cloud-runtime-cli/main/script/install.ps1 -useb | iex"

Configurer le CLI

Configurez votre Account à l'aide de cette commande :

vcr configure 

La commande vous demandera une région par défaut ainsi que la clé et le secret de l'API de Vonage que vous pouvez obtenir à partir du tableau de bord de l'API.

Fichier de configuration CLI

vcr configure écrit vos informations d'identification et vos préférences à ~/.vcr-cli. Vous pouvez également éditer ce fichier directement. Le fichier utilise le format INI :

[default]
graphql_endpoint = https://api-eu.vonage.com/v1/vcr/euw1/api/graphql/v1/graphql
default_region = aws.euw1

[credentials]
apikey = YOUR_API_KEY
apisecret = YOUR_API_SECRET

Les graphql_endpoint pour chaque région :

Région Point final
UE Ouest (aws.euw1) https://api-eu.vonage.com/v1/vcr/euw1/api/graphql/v1/graphql
Est des États-Unis (aws.use1) https://api-us.vonage.com/v1/vcr/use1/api/graphql/v1/graphql
AP Sud-Est (aws.apse1) https://api-ap.vonage.com/v1/vcr/apse1/api/graphql/v1/graphql
AP Southeast Sydney (aws.apse2) https://api-ap.vonage.com/v1/vcr/apse2/api/graphql/v1/graphql

Mise à jour du CLI

Pour mettre à jour l'exécution de la CLI :

vcr upgrade

La version actuelle de l'interface de programmation que vous avez installée sera imprimée. Si une version plus récente est disponible, vous serez invité à l'installer.

REMARQUE : Il se peut que vous deviez exécuter la commande à l'aide de sudo pour donner à la CLI du moteur d'exécution Cloud les permissions de déplacer la nouvelle version de la CLI dans le dossier d'installation. Vous pouvez également effectuer le déplacement vous-même.

Utilisation de l'interface de programmation

Pour initialiser un projet, exécutez la commande suivante pour commencer à saisir vos données :

vcr init

L'exécution de la commande vous invitera à fournir les informations suivantes :

  • Nom du projet: un nom pour votre projet.
  • Nom de l'instance: Saisissez un nom pour l'instance qui sera créée. Vous pouvez avoir plusieurs instances pour un même projet, ce nom doit donc être mémorable.
  • Temps d'exécution: Sélectionnez la durée d'exécution que vous souhaitez utiliser lorsque le code est exécuté.
  • Région: Sélectionnez la région dans laquelle vous souhaitez que votre instance fonctionne.
  • ID de l'application pour l'instance: Pour pouvoir utiliser les API de Vonage, une Application est nécessaire. Sélectionnez l'ID de l'application que vous souhaitez utiliser ; si vous n'en avez pas encore créé une, vous pouvez sauter cette étape et saisir l'ID plus tard. Pour créer une application, allez dans la section Page Applications sur le tableau de bord de Vonage ou exécutez vcr app create. Lorsque vous déployez votre instance, Cloud Runtime configure automatiquement pour vous les webhooks sur votre application.
  • ID de l'application pour le débogage: Vous pouvez fournir un ID d'application distinct à utiliser uniquement pour le débogage, ce qui signifie que votre instance déployée et l'Application et les webhooks correspondants ne seront pas affectés par le débogage local.
  • Modèle: Choisissez un modèle dans la liste pour visualiser un projet existant. La liste complète des modèles se trouve dans la rubrique Hub de code

Une fois que vous avez saisi toutes les informations nécessaires, un vcr.yml Un fichier de configuration sera créé, dans lequel vous pourrez ajouter tout ce que vous avez omis ou modifier les détails que vous venez de fournir. Si vous avez sélectionné un modèle, les fichiers nécessaires à l'exécution de cette application seront également téléchargés. Vous pouvez maintenant ouvrir ces fichiers dans votre configuration locale pour commencer à visualiser et à modifier le projet.

Prochaines étapes

Lorsque vous travaillez sur votre projet, les ressources suivantes peuvent vous être utiles :

  • Débogage: Déboguez votre code localement comme s'il était déployé sur la plateforme.
  • Déploiement: Lorsque votre projet est prêt, créez rapidement une instance opérationnelle sur la plateforme en la déployant.

Gestion des applications

Vous pouvez gérer les Applications Vonage à partir de l'interface de gestion à l'aide de la commande vcr app commandes.

Pour créer une nouvelle application :

vcr app create --voice --messages

Pour régénérer la clé privée et la clé publique d'une application existante :

vcr app generate-keys --app-id YOUR_APPLICATION_ID

Cette opération remplace la paire de clés existante de l'application. La nouvelle clé privée sera téléchargée et vous devrez mettre à jour toutes les références à celle-ci dans votre projet ou vos secrets.