Einführung in das Netzwerk-Register

Einführung

Netzwerk-APIs sind für Unternehmen gedacht, nicht für Einzelpersonen, Hobbyisten oder unabhängige Entwickler. Daher müssen Sie Ihr Unternehmensprofil zur Genehmigung durch die Kommunikationsdienstleister (CSPs) einreichen, bevor Sie Netzwerk-API-Aufrufe tätigen können, um Zugang zu erhalten. Um diesen Prozess zu vereinfachen, übernimmt Vonage im Hintergrund die Registrierung bei verschiedenen CSPs für alle unterstützten Netzwerk-APIs in allen Ländern, in denen Vonage-Dienste verfügbar sind.

Das Genehmigungsverfahren besteht aus zwei Schritten:

1. Erstellen Sie ein Unternehmensprofil.

2. Erstellen Sie ein Bewerbungsprofil.

Beide Schritte können über die Vonage Network Registry durchgeführt werden, entweder vom dem Dashboard oder über API.

Voraussetzungen

In dieser Anleitung wird davon ausgegangen, dass Sie bereits einen Account bei Vonage haben. Wenn Sie noch keines haben, können Sie eines erstellen hier.

Dashboard der Netzwerkregistrierung

Die Netzwerkregistrierung kann über das Dashboard des Benutzers aufgerufen werden. Melden Sie sich bei Ihrem Vonage Account an und klicken Sie unter Ihrem Avatar-Bild auf der rechten Seite des Portals auf "Mein Dashboard". Verwenden Sie das linke Navigationsmenü, um den Abschnitt "Erstellen und Verwalten" zu finden. Klicken Sie dann auf "Registry -> Network Registry".

Ein Geschäftsprofil erstellen

Das Geschäftsprofil enthält rechtliche Informationen über Ihr Unternehmen. Klicken Sie auf "Unternehmensprofil hinzufügen" und füllen Sie das Formular aus, indem Sie die folgenden Informationen über Ihr Unternehmen angeben:

• Land - wo Ihre Endnutzer auf Ihre Applications zugreifen können.

• Rolle - Ihre Rolle in Ihrer Organisation.

• Business Name - der Name der juristischen Person, die Eigentümerin der Applikationen ist, die die Vonage Network APIs nutzen werden.

• Art der Organisation - wählen Sie die am besten geeignete Art aus der Dropdown-Liste.

• Registrierte Adresse/Land - die Adresse und das Land, in dem Ihre Organisation registriert ist.

• Gewerbesteuernummer - Ihre Steuerreferenz, die von Vonage und seinen CSPs verwendet wird, um Ihre Organisation zu validieren.

• URL für Datenschutzrichtlinien-Vonage und seine CSPs verlangen, dass jeder, der Netzwerk-APIs verwendet, über eine Datenschutzrichtlinie verfügt, die im Internet öffentlich zugänglich ist. Geben Sie die URL für Ihre Richtlinie an.

• E-Mail-Adresse des Datenschutzbeauftragten - Geben Sie eine E-Mail-Adresse an, die für alle Fragen zu Ihrer Datenschutzrichtlinie verwendet werden kann.

• E-Mail-Adresse des behördlichen Datenschutzbeauftragten (DSB) - nur, wenn Sie gesetzlich verpflichtet sind, eine zu haben.

New Business Profile

Nach dem Absenden sehen Sie eine Zusammenfassung Ihres Unternehmensprofils. Diese Zusammenfassung hilft Ihnen, den Überblick über den Stand Ihrer Registrierung zu behalten. Sie werden per E-Mail benachrichtigt, wenn sich der Status Ihrer Anmeldung ändert.

Die Antworten der CSPs auf die Genehmigungsanfragen erfolgen asynchron und können zu unterschiedlichen Zeiten bei der Vonage Network Registry eingehen.

Erstellen Sie ein Anwendungsprofil

Anwendungsprofile werden verwendet, um einen bestimmten Anwendungsfall zu beschreiben, einschließlich der erforderlichen Netz-APIs und des Zwecks, für den sie verwendet werden sollen. Sie werden an die CSPs in den Ländern weitergegeben, die im zugehörigen Geschäftsprofil enthalten sind.

Gehen Sie im linken Navigationsmenü zum Eintrag Netzwerkregistrierung, klicken Sie auf den Namen des Unternehmensprofils und wählen Sie dann "Anwendungsprofil hinzufügen". Es wird ein Formular angezeigt, in dem Sie weitere Informationen über die Art der Anwendung, die Sie erstellen, angeben müssen:

• Profilname - Geben Sie Ihrem Anwendungsprofil einen Namen, um es leichter identifizieren zu können.

• Kategorie - Wählen Sie eine Anwendungskategorie aus der Dropdown-Liste.

• Infrastrukturstandorte - Geben Sie die Länderstandorte an, in denen Sie personenbezogene Daten im Zusammenhang mit der Nutzung der angeforderten Netzwerk-APIs verarbeiten dürfen.

• Netzwerk-APIs - Wählen Sie die Netzwerk-APIs aus, die Sie möglicherweise verwenden möchten.

• Zweck - Bestätigen Sie für jede ausgewählte Netzwerk-API den Zweck aus der Dropdown-Liste, z. B. "Betrugsprävention und -aufdeckung".

• Beschreibung des Anwendungsfalls: Beschreiben Sie Ihre Anwendung aus der Sicht des Verbrauchers.

New Application Profile

Nach der Einreichung erhalten Sie eine Zusammenfassung Ihrer Anfrage für das Bewerbungsprofil. Sie werden per E-Mail benachrichtigt, wenn sich der Status Ihrer Bewerbung ändert.

Überwachung meines Beitrags

Sie können den Status des Genehmigungsverfahrens für Ihr Anwendungsprofil verfolgen. Gehen Sie zum Eintrag Netzwerk-Register im linken Navigationsmenü und klicken Sie auf Ihr Unternehmensprofil. Die Übersichtsseite des Unternehmensprofils wird angezeigt. Klappen Sie dort den Eintrag Anwendungsprofile am unteren Rand der Seite aus. Es erscheint eine Liste der CSPs aus den Ländern, die Sie bei der Erstellung Ihres Geschäftsprofils ausgewählt haben, zusammen mit ihrem Genehmigungsstatus.

Network APIs Submission Status

Netzwerk-Registrierungs-API

Die Network Registry API ermöglicht es Entwicklern, Geschäfts- und Anwendungsprofile programmatisch zu übermitteln. Dies ist besonders nützlich, wenn verschiedene Teams innerhalb Ihres Unternehmens die Netzwerk-APIs verwenden, so dass jedes Team bei Bedarf über interne Prozesse unterschiedliche Anwendungsprofile erstellen und verwenden kann.

Authentifizierung

Alle Aufrufe der Network Registry API erfordern eine Authentifizierung, um abgeschlossen zu werden. Die Authentifizierung basiert auf dem API-Schlüssel und dem Geheimnis, die auf der Übersichtsseite Ihres Dashboards zu finden sind und in der URL gesendet werden.

API Key Secret

Warnung: Ihre API-Anmeldedaten sind geheim und nur für den persönlichen Gebrauch bestimmt. Geben Sie sie nicht an Dritte weiter.

Business-Profile

Der /business-profile Endpunkt wird für alle Geschäftsprofiloperationen verwendet: Erstellen, Abrufen, Löschen, usw.

Um ein neues Geschäftsprofil zu erstellen, müssen wir einen POST Anfrage senden. Der Hauptteil des Aufrufs enthält die gleichen Informationen, die auch vom Dashboard des Netzregisters angefordert werden (Rolle, Land, Steuernummer usw.).

Das folgende Beispiel verwendet cURL, um ein neues Unternehmensprofil mit der Bezeichnung "Mein Unternehmensprofil" zu erstellen und den Zugang zu Betreibern in Spanien und Deutschland zu beantragen:

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

Wir könnten eine GET-Anfrage senden, um eine Liste von Geschäftsprofilen abzurufen und ihren Status zu überwachen:

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

Es ist auch möglich, die Geschäftsprofilinformationen für einen bestimmten CSP abzurufen, indem man eine GET Anfrage an den /business-profile/{id}/csps Endpunkt senden:

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

Wenn wir ein Geschäftsprofil ändern wollen, können wir eine PUT-Anfrage an den /change-request-Server senden.

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

Schließlich können wir ein bestehendes Geschäftsprofil löschen, indem wir diesen Befehl ausführen:

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

Anwendungsprofil

Ähnlich wie bei den Geschäftsprofilen können wir mit dem /application-profiles Endpunkt verwenden, um alle Vorgänge im Zusammenhang mit Anwendungsprofilen durchzuführen.

Das folgende Beispiel sendet eine POST-Anfrage zum Erstellen eines neuen Anwendungsprofils:

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

Wir könnten eine Liste von Anwendungsprofilen abrufen, indem wir eine GET-Anfrage senden. Wir könnten das Ergebnis filtern, indem wir Abfrageparameter wie Status (ausstehend, angenommen, abgelehnt, usw.) oder business_profile_idum Anwendungsprofile von einem bestimmten Unternehmensprofil zu erhalten.

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

Die API-Referenz enthält eine detaillierte Beschreibung der übrigen Vorgänge.

Mehr Operationen

Neben den Vorgängen zur Verwaltung von Geschäfts- und Anwendungsprofilen bietet die Network Registry API nützliche Endpunkte für die Arbeit mit anderen Ressourcen, wie Ländern, unterstützten Netzwerk-APIs oder Organisationstypen.

Um eine Liste der unterstützten Länder zu erhalten, könnten wir eine GET-Anfrage wie in diesem Beispiel senden:

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

In ähnlicher Weise können Sie eine GET-Anfrage an die Adresse /network-api Endpunkt eine Liste der unterstützten Netzwerk-APIs abrufen:

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

Der Katalog Abschnitt der API-Referenz enthält eine Liste der Ressourcen, auf die man über /Katalog Endpunkt zugegriffen werden kann.

Was kommt als Nächstes?

Sobald Ihr Antrag von mindestens einem seiner CSPs genehmigt wurde, können Sie ihn mit einer oder mehreren Vonage Applications verknüpfen, um die Netzwerk-APIs zu nutzen. Die Vonage-Anwendung enthält die Anmeldedaten, die für API-Anrufe erforderlich sind.

Kontakt aufnehmen

Wir würden uns freuen, von Ihnen zu hören! Treten Sie der Vonage Community Slack um Ihre Erfahrungen mit der Network Registry zu teilen. Sie können dem Vonage Developer Experience Team auch folgen auf X, früher bekannt als Twitter.