Registre du réseau API

La procédure de demande d'approbation décrite dans le Registre du réseau peut également être géré de manière programmatique à l'aide de la fonction Registre du réseau API. Cela permet d'automatiser le processus d'approbation.

Référence API

La spécification OpenAPI pour l'API du registre du réseau est disponible. ici.

Authentification

L'authentification est basée sur votre Clé API et Secret de l'APIqui se trouve dans le tableau de bord du développeur.

Gestion des profils commerciaux

Vous pouvez créer, récupérer et supprimer des profils d'entreprise à l'aide de la fonction /business-profile point final.

L'exemple suivant est une requête

POST

qui crée un nouveau profil d'entreprise appelé "Mon profil d'entreprise", demandant l'accès aux opérateurs en Espagne et en Allemagne. Le corps de l'appel contient les mêmes informations que celles demandées par le tableau de bord du registre du réseau (rôle, pays, numéro d'imposition, etc.) :

curl -X POST "http://api-eu.vonage.com/v1/network-registry/business-profiles" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
   "countries": [
      "ES",
      "DE"
   ],
   "contact_role": "A Business Profile",
   "name": "A Business Profile",
   "trading_name": "A Business Profile Ltd.",
   "organization_type": "forProfitOrganization",
   "tax_number": "98284687G",
   "business_registration_id": "15-048-3782",
   "issuing_authority": "National Government",
   "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": "ES",
      "city": "London",
      "province": "City of London"
   },
   "email_notifications_enabled": true,
   "vetting_terms_and_conditions_accepted": true,
   "vetting_extra_fields": {
      "tax_number_type": "NIF",
      "duns_number": "123456789"
   }
}'

Pour modifier un profil d'entreprise, envoyez une demande

PUT

à l'aide de la commande /change-request et l'identifiant de votre profil d'entreprise :

curl -X PUT "http://api-eu.vonage.com/v1/network-registry/business-profiles/$BUSINESS-PROFILE-ID/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.",
   "organization_type": "For-Profit Organization",
   "tax_number": "98284687G",
   "business_registration_id": "15-048-3782",
   "issuing_authority": "National Government",
   "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": "ES",
      "city": "London",
      "province": "City of London"
   },
   "email_notifications_enabled": true,
   "vetting_terms_and_conditions_accepted": true,
   "vetting_extra_fields": {
      "tax_number_type": "NIF",
      "duns_number": "123456789"
   }
}'

Une liste complète de toutes les opérations et de tous les paramètres peut être consultée dans la rubrique Référence API.

Gestion des profils d'application

Les /application-profiles peut être utilisé pour effectuer toutes les opérations liées aux profils d'application. Cet exemple 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": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
   "name": "Network Application Profile",
   "description": "This Network Application Profile main use case is for Fraud Prevention",
   "category_id": "finance",
   "network_apis": [
      {
         "network_api_id": "sim-swap",
         "purpose_ids": [
            "FraudPreventionAndDetection"
         ]
      }
   ],
   "terms_and_conditions_accepted": true,
   "infrastructure_locations": [
      "ES"
   ],
   "privacy_policy_url": "https://www.businessinc.com/application_privacy_policy"
}'

Une liste complète de toutes les opérations et de tous les paramètres peut être consultée dans la rubrique Référence API.

Autres opérations

Les /catalogue point final peut être utilisée pour répertorier des ressources utiles telles que des pays, des catégories, des types d'organisation ou des objectifs :

GET
/v1/network-registry/catalogue/countries: Liste des pays pris en charge
GET
/v1/network-registry/catalogue/organization-types: Liste des types d'organisation pris en charge
GET
/v1/network-registry/catalogue/categories: Liste des catégories prises en charge
GET
/v1/network-registry/catalogue/network-apis: Liste des fonctionnalités réseau prises en charge
GET
/v1/network-registry/catalogue/purposes: Liste des objectifs pris en charge