Gestion des applications

Une application API Vonage contient les informations de sécurité et de configuration dont vous avez besoin pour vous connecter aux points d'extrémité Vonage et utiliser les API Vonage. Chaque application Vonage créée peut prendre en charge plusieurs capacités. Par exemple, vous pouvez créer une application qui prend en charge l'utilisation des API Voice, Messages et RTC.

Vous pouvez utiliser la CLI de Vonage pour créer et gérer vos applications, ajouter de nouvelles capacités et mettre à jour vos informations de configuration de webhook.

Création d'une application

Les vonage apps create <name> vous permet de créer une application. Vous devez fournir un nom d'application, car l'interface de programmation n'en génère pas pour vous.

La commande dispose des drapeaux suivants :

Note : Si vous ne fournissez pas votre propre clé, Vonage en créera une pour vous. Cependant, si vous n'enregistrez pas la clé lors de la création de l'application, vous ne pourrez plus y accéder. Vous devrez régénérer la clé si vous la perdez.

vonage apps create 'Your application'

✅ Creating Application
Saving private key ... Done!
Application created

Name: Your application
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set

Capabilities:
  None Enabled

Liste de vos applications

Par défaut, lorsque vous exécutez vonage apps il exécutera la même sous-commande que vonage apps list. Il existe un certain nombre de drapeaux que vous pouvez passer pour affiner votre recherche :

vonage apps

✅ Loading applications... Done

App ID                                Name               Capabilities
------------------------------------  -----------------  ------------------------------------------------------
00000000-0000-0000-0000-000000000000  Application        None
00000000-0000-0000-0000-000000000000  voice Application  Messages, Voice
00000000-0000-0000-0000-000000000000  All enabled        Messages, Network APIs, RTC, VBC, Verify, Video, Voice

Afficher les détails de l'application

Les show vous permet d'obtenir les détails d'une application spécifique. Le format de la commande est le suivant vonage apps show <id>où <id> est l'UUID de l'application.

Remarque : cette opération n'affiche pas la clé publique. Si vous avez besoin d'afficher la clé publique, vous pouvez utiliser la commande --show-all, --jsonou --yaml drapeaux, qui n'expurgera aucune information.

vonage apps show 00000000-0000-0000-0000-000000000000

✅ Fetching application

Name: All enabled
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set

Capabilities:
  VOICE:
    Uses Signed callbacks: On
    Conversation TTL: 41 hours
    Leg Persistence Time: 6 days
    Event URL: [GET] https://example.com/voice/event
    Answer URL: [GET] https://example.com/voice/answer
    Fallback URL: [GET] https://example.com/voice/fallback
  
  MESSAGES:
    Authenticate Inbound Media: On
    Webhook Version: v1
    Status URL: [POST] https://example.com/meetings/status
    Inbound URL: [POST] https://example.com/meetings/inbound
  
  VERIFY:
    Webhook Version: v2
    Status URL: [POST] https://example.com/verify2/status
  
  RTC:
    Event URL: [POST] https://example.com/rtc/event
    Uses Signed callbacks: On
  
  VIDEO:
    Archive Status URL: [POST] https://example.com/video/archive-status
    Archive Status Signature Secret: archive status
    Broadcast Status URL: [POST] https://example.com/video/broadcast-status
    Broadcast Status Signature Secret: broadcast status
    Caption Status URL: [POST] https://example.com/video/caption-status
    Caption Status Signature Secret: caption-status
    Connection Created URL: [POST] https://example.com/video/connected-created
    Connection Created Signature Secret: connection created
    Connection Destroyed URL: [POST] https://example.com/video/connection-destroyed
    Connection Destroyed Signature Secret: connection destroyed
    Render Status URL: [POST] https://example.com/video/render-status
    Render Status Signature Secret: render status
    SIP Call Created URL: [POST] https://example.com/video/sip1
    SIP Call Created Signature Secret: Off
    SIP Call Destroyed URL: [POST] https://example.com/video/sip3
    SIP Call Destroyed Signature Secret: Off
    SIP Call Mute Forced URL: [POST] https://example.com/video/sip4
    SIP Call Mute Forced Signature Secret: Off
    SIP Call Updated URL: [POST] https://example.com/video/sip2
    SIP Call Updated Signature Secret: Off
    Stream Created URL: [POST] https://example.com/video/stream-created
    Stream Created Signature Secret: stream created
    Stream Destroyed URL: [POST] https://example.com/video/stream-destroyed
    Stream Destroyed Signature Secret: stream destroyed
  
    RECORDINGS STORAGE:
      Cloud Storage: On
      Storage Type: AmazonS3
      Credential: manchuck_aws_bucket
      End to End Encryption: On
      Server Side Encryption: On
  
  NETWORK APIS:
    Redirect URL: [GET] https://example.com/gnp/redirect
  
  NB: VBC capabilities is not supported through the command line.

Mise à jour d'une application

vonage apps update <id> vous permet de mettre à jour le nom d'une application existante, de modifier le paramètre Improve AI ou de définir une nouvelle clé publique :

vonage apps update 00000000-0000-0000-0000-000000000000 `
  --name="New Application Name"
  
✅ Fetching Application
✅ Updating Application

Name: New Application Name
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set

Supprimer une application

Vous pouvez supprimer une application avec la commande vonage apps delete <id>où id est l'UUID de l'application :

vonage apps delete 00000000-0000-0000-0000-000000000000

✅ Fetching application
Delete application New Name (7d7133ab-de4e-4b7a-8e1e-376670077c71)? [y/n] 
✅ Deleting application