Introduction au registre du réseau

Introduction

Les API de réseau sont destinées aux entreprises, et non aux particuliers, aux amateurs ou aux développeurs indépendants. Par conséquent, avant d'effectuer des appels aux API de réseau, vous devez soumettre le profil de votre entreprise à l'approbation des fournisseurs de services de communication (FSC) pour obtenir l'accès. Pour simplifier ce processus, Vonage gère en coulisses l'enregistrement auprès de divers FSC pour toutes les API de réseau prises en charge dans tous les pays où les services de Vonage sont disponibles.

La procédure d'approbation se déroule en deux étapes :

1. Créez un profil d'entreprise.

2. Créer un profil de candidature.

Les deux étapes peuvent être effectuées à l'aide du registre du réseau de Vonage, soit à partir du tableau de bord, soit à partir de la page d'accueil. tableau de bord ou par l'intermédiaire de l API.

Conditions préalables

Ce tutoriel suppose que vous disposez déjà d'un Account Vonage. Si vous n'en avez pas, vous pouvez en créer un ici.

Tableau de bord du registre du réseau

Le registre du réseau est accessible à partir du tableau de bord de l'utilisateur. Connectez-vous à votre Account Vonage, et sous votre image avatar sur le côté droit du portail, cliquez sur "Mon tableau de bord". Utilisez le menu de navigation de gauche pour trouver la section Build & Manage (Construire et gérer). Cliquez ensuite sur Registry -> Network Registry.

Créer un profil d'entreprise

Le profil d'entreprise comprend des informations juridiques sur votre entreprise. Cliquez sur "Ajouter un profil d'entreprise"et complétez le formulaire en fournissant les informations suivantes sur votre organisation :

• Pays - où vos utilisateurs finaux peuvent accéder à vos Applications.

• Rôle - votre rôle dans votre organisation.

• Nom de l'entreprise - le nom de l'entité juridique qui possède les applications qui utiliseront les API du réseau Vonage.

• Type d'organisation - sélectionnez le type le plus approprié dans la liste déroulante.

• Adresse du siège de l'entreprise/pays - l'adresse et le pays où votre organisation est enregistrée.

• Numéro de taxe professionnelle - votre référence fiscale utilisée par Vonage et ses FSC pour valider votre organisation.

• URL de la politique de confidentialité-Vonage et ses CSP exigent que toute personne utilisant les API du réseau dispose d'une politique de confidentialité accessible au public sur l'internet. Indiquez l'URL de votre politique.

• Adresse électronique du responsable de la politique de protection de la vie privée - indiquez une adresse électronique à utiliser pour toute question relative à votre politique de protection de la vie privée.

• L'adresse électronique du délégué à la protection des données (DPD) - uniquement si la loi vous oblige à en avoir une.

New Business Profile

Après avoir envoyé votre demande, vous verrez un résumé de votre profil d'entreprise. Ce résumé vous permet de suivre l'état de votre inscription. Vous recevrez des notifications par courrier électronique lorsque le statut de votre inscription changera.

Les réponses des CSP aux demandes d'approbation sont asynchrones et peuvent être reçues par le Vonage Network Registry à des moments différents.

Créer un profil d'application

Les profils d'applications sont utilisés pour décrire un cas d'utilisation spécifique, y compris les API de réseau qui sont nécessaires et l'objectif pour lequel elles seront utilisées. Ils seront partagés avec les CSP des pays inclus dans le profil commercial associé.

Accédez à l'entrée Registre du réseau dans le menu de navigation de gauche, cliquez sur le nom du profil d'entreprise, puis sélectionnez "Ajouter un profil d'application." Un formulaire apparaîtra dans lequel vous devrez fournir plus d'informations sur le type d'application que vous construisez :

• Nom du profil - Donnez un nom à votre profil d'application pour faciliter son identification.

• Catégorie - Sélectionnez une catégorie d'application dans la liste déroulante.

• Emplacement de l'infrastructure - Précisez l'emplacement des pays où vous pouvez traiter les données à caractère personnel liées à l'utilisation des API de réseau demandées.

• Network APIs - Sélectionnez les Network APIs que vous souhaitez utiliser.

• Objet - Pour chaque API de réseau sélectionnée, confirmez l'objet dans la liste déroulante, par exemple "Prévention et détection des fraudes".

• Description du cas d'utilisation : Décrivez votre application du point de vue du consommateur.

New Application Profile

Après la soumission, vous recevrez un résumé de votre demande de profil de candidature. Des notifications par courrier électronique vous seront envoyées chaque fois qu'un changement interviendra dans le statut de votre demande.

Suivi de ma soumission

Vous pouvez suivre l'état d'avancement de la procédure d'approbation de votre profil de candidature. Allez à l'entrée Registre du réseau dans le menu de navigation de gauche et cliquez sur votre profil d'entreprise. La page de présentation du profil d'entreprise s'affiche. Une fois sur cette page, décompressez l'entrée relative aux profils de candidature en bas de la page. Une liste des CSP des pays que vous avez sélectionnés lors de la création de votre profil d'entreprise, avec leur statut d'approbation, s'affiche.

Network APIs Submission Status

API du registre du réseau

L'API du registre du réseau permet aux développeurs de soumettre des profils d'entreprise et d'application par programme. Ceci est particulièrement utile lorsque différentes équipes au sein de votre organisation utilisent les API de réseau, permettant à chaque équipe de créer et d'utiliser des profils d'application distincts en fonction des besoins par le biais de processus internes.

Authentification

Tous les appels de l'API Network Registry nécessitent une authentification. L'authentification est basée sur la clé et le secret de l'API, qui peuvent être trouvés sur la page d'aperçu de votre tableau de bord et qui sont envoyés dans l'URL. seront envoyés dans l'URL.

API Key Secret

Avertissement : Vos identifiants API sont secrets et réservés à un usage personnel. Ne les communiquez à personne.

Profils d'entreprises

Le point d'arrivée /business-profile est utilisé pour toutes les opérations relatives aux profils d'entreprise : création, récupération, suppression, etc.

Pour créer un nouveau profil d'entreprise, nous devons envoyer un formulaire POST . Le corps de l'appel contiendra les mêmes informations que celles demandées par le tableau de bord du Registre du réseau (rôle, pays, numéro fiscal, etc.).

L'exemple suivant utilise cURL pour créer un nouveau profil d'entreprise appelé "Mon profil d'entreprise", demandant l'accès aux opérateurs en Espagne et en Allemagne :

curl -X POST "http://api-eu.vonage.com/v1/network-registry/business-profiles" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
  "contact_role":"developer",
  "name":"my business profile",
  "organisation_type":"forProfitOrganisation",
  "country":"ES",
  "tax_number":"1234567890",
  "privacy_policy_url":"https://1LThiQzd.com",
  "privacy_policy_manager_email":"manager@test.com",
  "dpo_email":"dpo@test.com",
  "dpo_required":true,
  "countries":[
    "ES",
    "DE"
  ],
  "business_information":{
    "address_street_1":"address 1",
    "address_street_2":"address 2",
    "city":"Madrid",
    "province":"Madrid",
    "postal_code":"28020",
    "country":"ES"
  },
  "email_notifications_enabled":true,
  "terms_and_conditions_accepted":true
}'

Nous pourrions envoyer une requête GET pour récupérer une liste de profils d'entreprises afin de contrôler leur statut :

curl "http://api-eu.vonage.com/v1/network-registry/business-profiles" -u ${API_Key}:${API_Password}

Il est également possible de récupérer les informations relatives au profil commercial d'un CSP donné en envoyant une requête GET à l'adresse /business-profile/{id}/csps en envoyant une requête GET au point d'accès

curl "http://api-eu.vonage.com/v1/network-registry/business-profiles/0934561-99ce-123/csps" -u ${API_Key}:${API_Password}

Si nous voulons modifier un profil d'entreprise, nous pouvons envoyer une demande PUT à l'adresse /change-request

curl -X PUT "http://api-eu.vonage.com/v1/network-registry/business-profiles/0934561-99ce-123/change-request" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
   "countries": [
      "ES"
   ],
   "contact_role": "A Business Profile",
   "name": "A Business Profile",
   "trading_name": "A Business Profile Ltd.",
   "organisation_type": "For-Profit Organisation",
   "tax_number": "98284687G",
   "privacy_policy_url": "https://www.businessinc.com/privacy_policy",
   "privacy_policy_manager_email": "privacy.manager@business.com",
   "dpo_email": "dpo@business.com",
   "dpo_required": true,
   "terms_and_conditions_accepted": true,
   "business_information": {
      "address_street_1": "Main Street 5",
      "address_street_2": "Extra long address",
      "postal_code": "W1 5DU",
      "country": "UK",
      "city": "London",
      "province": "City of London"
   },
   "email_notifications_enabled": true
}'

Enfin, nous pouvons supprimer un profil d'entreprise existant en exécutant la commande suivante :

curl -X DELETE "http://api-eu.vonage.com/v1/network-registry/business-profiles/0934561-99ce-123

Profil de l'application

Comme pour les profils d'entreprise, nous pouvons utiliser le point de terminaison /application-profiles pour effectuer toutes les opérations liées aux profils d'application.

L'exemple suivant envoie une requête POST pour créer un nouveau profil d'application :

curl -X POST "http://api-eu.vonage.com/v1/network-registry/application-profiles" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
   "business_profile_id": "string",
   "name": "Network Application Profile",
   "description": "This is an example use case for Fraud Prevention",
   "category_id": "finance",
   "network_apis": [
      {
         "network_api_id": "sim-swap",
         "purpose_ids": [
            "FraudPreventionAndDetection"
         ]
      }
   ],
   "terms_and_conditions_accepted": true,
   "infrastructure_locations": [
      "ES"
}'

Nous pourrions récupérer une liste de profils d'application en envoyant une requête GET. Nous pourrions filtrer le résultat en envoyant des paramètres de requête tels que l'état (en attente, accepté, rejeté, etc.) ou business_profile_idpour obtenir les profils de candidature d'un profil d'entreprise spécifique.

curl "http://api-eu.vonage.com/v1/network-registry/application-profiles" -u ${API_Key}:${API_Password}

La référence de l'API Référence API contient une description détaillée des autres opérations.

Plus d'opérations

Au-delà des opérations de gestion des profils d'entreprise et d'application, l'API Network Registry fournit des points d'extrémité utiles pour exploiter d'autres ressources, telles que les pays, les API de réseau prises en charge ou les types d'organisation.

Pour obtenir la liste des pays pris en charge, nous pouvons envoyer une requête GET comme dans l'exemple suivant :

curl "http://api-eu.vonage.com/v1/network-registry/catalogue/countries" -u ${API_Key}:${API_Password}

De même, en envoyant une requête GET à l'adresse /network-api nous pourrions obtenir une liste des API de réseau prises en charge :

curl "http://api-eu.vonage.com/v1/network-registry/catalogue/network-apis" -u ${API_Key}:${API_Password}

Le catalogue de la référence API de la Référence API contient une liste de ressources auxquelles on peut accéder via la commande /catalogue .

Quelle est la prochaine étape ?

Une fois que votre soumission est approuvée par au moins un de ses CSP, vous pouvez la lier à une ou plusieurs applications Vonage pour commencer à utiliser les API du réseau. L'application Vonage contient les informations d'identification nécessaires pour effectuer des appels API.

Prendre contact

Nous aimerions avoir de vos nouvelles ! Rejoignez la Communauté Vonage Slack de Vonage pour partager vos expériences avec le Network Registry. Vous pouvez également suivre l'équipe Vonage Developer Experience sur Xanciennement connu sous le nom de Twitter.