Authentification

L'API Verify prend en charge deux types d'authentification :

Quand faut-il utiliser l'authentification de base ou le JWT ?

Vous pouvez utiliser l'une ou l'autre option, mais pas les deux en même temps. En règle générale, nous recommandons d'utiliser JWT lors de l'utilisation de l'API Verify. Bien que l'authentification de base soit plus facile à mettre en œuvre, elle ne prend pas en charge les fonctions de l'API Verify. Authentification silencieuse canal.

Authentification de base

L'authentification de base envoie votre clé API et votre secret API dans les en-têtes de la demande. Vous trouverez ces informations d'identification dans votre fichier Tableau de bord.

Avertissement : La clé API et le secret sont sensibles ! Si vous les exposez publiquement (code frontend, dépôts GitHub, etc.), n'importe qui peut abuser de votre Account.

Pour créer l'en-tête de la demande :

Commencez par concaténer votre clé API et votre secret : API_KEY:API_SECRET.
Ensuite, Encodage Base64 le résultat.
Enfin, envoyez-le dans la demande sous la forme suivante Authorization: Basic BASE64_ENCODED_STRING.

Vous pouvez le faire dans le code de votre application - par exemple, en JavaScript :

const credentials = btoa('YOUR_API_KEY:YOUR_API_SECRET');

const response = await fetch('https://api-eu.vonage.com/v2/verify', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic ' + credentials
  },
  body: JSON.stringify({ ... })
});

JWT

A JWT (JSON Web Token) est un standard ouvert (RFC 7519) pour la transmission sécurisée d'informations entre les parties sous la forme d'un objet JSON. L'objet peut éventuellement être crypté et signé à l'aide d'une clé privée/publique.

Pour générer un JWT, vous aurez besoin de votre fichier application ID et private keyqui se trouvent tous deux dans le Applications dans votre Tableau de bord.

Attention : La génération de tous les JWT doit être effectuée dans le backend. Le délai d'expiration des jetons ne doit pas être plus long que nécessaire.

Il existe plusieurs façons de générer un nouveau JWT :

L'utilisation de la Générateur en ligne JWT.
L'utilisation de la Outil CLI de Vonage. La clé privée et un identifiant de l'application doivent être fournis :

vonage auth set --app-id your_application_id --private-key /path/to/your/private.key vonage jwt create

A noter :

Si vous utilisez l'un des systèmes Vonage SDK de serveur il n'est pas nécessaire de générer un JWT séparément, car tous les SDK prennent en charge la génération de jetons JWT.
Si vous ne souhaitez pas générer le JWT à l'aide d'un outil ou d'une bibliothèque externe, comme les SDK de Vonage, vous pouvez mettre en œuvre votre propre génération de JWT. L'outil de génération de JWT de comment générer un JWT comprend des exemples en JavaScript et en Python qui montrent comment générer un JWT sans dépendances externes.

Une fois généré, les utilisateurs doivent pouvoir utiliser le jeton pour accéder aux points d'extrémité protégés. Cela se fait généralement à l'aide de l'en-tête Authorization qui utilise le schéma Bearer :

Authorization: Bearer <JWT>