Paramètres de l'API

La page Paramètres de l'API vous permet de gérer les informations d'identification de votre API, de configurer les webhooks et de contrôler le comportement de l'API SMS. Chaque clé API possède son propre ensemble d'informations d'identification et de configuration.

Accéder aux paramètres de l'API

1. Connectez-vous à votre tableau de bord Vonage
2. Naviguez jusqu'à Paramètres → Paramètres de l'API dans la barre latérale gauche.
3. Sélectionnez une clé API en haut de la page.

Une fois que vous avez sélectionné une clé API,

Clé et secret de l'API

Votre Clé API est affiché en haut de la page dans le menu déroulant du compte. Il s'agit d'un identifiant public utilisé dans les demandes d'API. Vous pouvez également lui donner un surnom pour l'identifier dans la plateforme (par exemple, "Production", "Développement", "Test").

Votre Secrets de l'API sont indiqués dans le Secret de la clé API section :

• Secret API 1 - Votre secret d'authentification principal (masqué par défaut)
• Secret API 2 - Votre secret secondaire pour la rotation (masqué par défaut)

Si vous n'avez pas encore de deuxième secret API, vous pourrez en créer un ici en cliquant sur le lien "Créer un nouveau secret".

Type d'API Messages

Configurez la façon dont Vonage traite les messages SMS pour cette clé API.

Vonage dispose de deux API différentes pour l'envoi de SMS. Vous ne pouvez en utiliser qu'une seule à la fois, car elle modifie le format des webhooks que vous recevez.

Choisissez votre API :

• SMS API - Ancienne API avec un format de webhook plus simple (GET ou POST)
• Messages API - API multicanal moderne avec webhooks JSON

Cliquez sur le bouton approprié pour sélectionner l'API que vous souhaitez utiliser.

SMS API

Format du webhook

Pour SMS API uniquementsélectionner le format des webhooks de réception de livraison (DLR) :

1. Cliquez sur le bouton Format du webhook liste déroulante.
2. Choisissez parmi :
   • GET - Données du webhook envoyées en tant que paramètres de requête de l'URL
   • POST - Données du webhook envoyées en tant que corps codé en formulaire
   • POST-JSON - Les données du webhook sont envoyées sous la forme d'un corps JSON (recommandé)

Webhooks pour les accusés de réception (DLR)

Recevoir des mises à jour sur l'état de livraison des messages SMS sortants.

1. Dans le cadre de la Accusés de réception (DLR) webhooks entrez l'URL de votre webhook.
2. Exemple : https://example.com/webhooks/delivery-receipt
3. Lorsqu'un SMS est délivré (ou échoue), Vonage envoie une mise à jour à cette URL.

Pour plus de détails sur la charge utile du webhook, voir la section Référence des Webhooks de l'API SMS.

Webhooks SMS entrants

Recevez des notifications lorsque quelqu'un envoie un SMS à votre numéro Vonage.

1. Dans le cadre de la Webhooks SMS entrants entrez l'URL de votre webhook.
2. Exemple : https://example.com/webhooks/inbound-sms
3. Lorsque quelqu'un envoie un SMS à votre numéro Vonage, le message est transféré à cette URL.

Pour plus de détails sur la charge utile du webhook, voir la section Référence des messages entrants de l'API SMS.

Messages API

Webhooks d'état

Recevoir des mises à jour de l'état des messages sortants.

1. Dans le cadre de la Crochets web d'état entrez l'URL de votre webhook.
2. Exemple : https://example.com/webhooks/status-updates
3. Lorsque l'état d'un message que vous avez envoyé change, Vonage envoie une mise à jour à cette URL.

Pour plus de détails sur la charge utile du webhook, voir la section Référence des webhooks de l'API Messages.

Crochets Web entrants

Recevez des notifications lorsqu'un client vous envoie un message.

1. Dans le cadre de la Crochets web entrants entrez l'URL de votre webhook.
2. Exemple : https://example.com/webhooks/inbound-message
3. Lorsque quelqu'un vous envoie un message via l'un de vos canaux de l'API Messages, le message est transféré vers cette URL.

Pour plus de détails sur la charge utile du webhook, voir la section Référence des messages entrants de l'API Messages.

Webhooks signés

Ajoutez une couche de sécurité facultative pour vérifier que les demandes de crochets Web proviennent bien de Vonage et qu'elles n'ont pas été altérées pendant le transport.

Signature Secret

Clé secrète utilisée pour générer la signature incluse dans les demandes de webhook.

1. Dans le cadre de la Crochets web signés section, consultez votre Secret de signature (masqué par défaut).
2. Cliquez sur le bouton icône de l'œil pour révéler le secret.
3. Cliquez sur le bouton icône de copie pour le copier dans votre presse-papiers.

Méthode de signature

Choisissez l'algorithme utilisé pour créer la signature du webhook :

1. Cliquez sur le bouton Méthode de signature liste déroulante.
2. Choisissez parmi :
   • Signature MD5 HASH (héritage, non recommandé)
   • Signature MD5 HMAC
   • Signature SHA1 HMAC
   • Signature SHA-256 HMAC (recommandé)
   • Signature SHA-512 HMAC (le plus sûr)

Lorsque cette option est activée, les demandes de webhook entrantes incluent un jeton JWT dans l'en-tête d'autorisation, qui est signé avec votre secret de signature. Pour en savoir plus validation des webhooks signés.

Conformité

Numéros HIPAA

Si votre Account a été activé pour l'achat de Numbers conformes aux normes HIPAA, vous verrez l'avis suivant :

Contactez votre Account Manager Vonage si vous avez besoin d'activer la conformité HIPAA pour votre cas d'utilisation.