Netzwerk-Registrierungs-API

Das Verfahren zur Beantragung einer Genehmigung, das in der Netzwerk-Register Anleitung kann auch programmatisch verwaltet werden, indem die Netzwerk-Registrierungs-API. Dies ermöglicht eine automatisierte Abwicklung des Genehmigungsverfahrens.

API-Referenz

Die OpenAPI-Spezifikation für die Network Registry API ist verfügbar hier.

Authentifizierung

Die Authentifizierung basiert auf Ihrer API-Schlüssel und API-Geheimnisdie sich in der Entwickler-Dashboard.

Verwalten von Geschäftsprofilen

Sie können Geschäftsprofile erstellen, abrufen und löschen, indem Sie die /business-profile Endpunkt.

Das folgende Beispiel ist ein

POST
-Aufruf, der ein neues Unternehmensprofil mit der Bezeichnung "Mein Unternehmensprofil" erstellt und den Zugang zu Betreibern in Spanien und Deutschland beantragt. Der Hauptteil des Aufrufs enthält die gleichen Informationen, die auch vom Dashboard des Netzregisters angefordert werden (Rolle, Land, Steuernummer usw.):

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"
   }
}'

Um ein Geschäftsprofil zu ändern, senden Sie eine

PUT
-Anfrage mit /change-request und die ID Ihres Unternehmensprofils:

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"
   }
}'

Eine vollständige Liste aller Operationen und Parameter finden Sie in der API-Referenz.

Verwalten von Anwendungsprofilen

Die /application-profiles Endpunkt kann verwendet werden, um alle Vorgänge im Zusammenhang mit Anwendungsprofilen durchzuführen. In diesem Beispiel wird eine

POST
-Anfrage zur Erstellung eines neuen Anwendungsprofils gesendet:

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"
}'

Eine vollständige Liste aller Operationen und Parameter finden Sie in der API-Referenz.

Andere Operationen

Die /catalogue Endpunkt kann verwendet werden, um nützliche Ressourcen wie Länder, Kategorien, Organisationstypen oder Zwecke aufzulisten:

  • GET
    /v1/network-registry/catalogue/countries: Liste der unterstützten Länder
  • GET
    /v1/network-registry/catalogue/organization-types: Liste der unterstützten Organisationstypen
  • GET
    /v1/network-registry/catalogue/categories: Liste der unterstützten Kategorien
  • GET
    /v1/network-registry/catalogue/network-apis: Liste der unterstützten Netzwerkfunktionen
  • GET
    /v1/network-registry/catalogue/purposes: Liste der unterstützten Zwecke