Führen Sie Ihren ersten Netzwerk-API-Aufruf mit dem Playground durch

In diesem Beitrag erfahren Sie, wie Sie Ihren ersten API-Aufruf an SIM-Tausch-API unter Verwendung des Playgrounds, einer sicheren Umgebung zum Testen und Interagieren mit den Netzwerk-APIs vor der Genehmigung durch die CSPs. Wir werden auch den Virtual CSP verwenden, einen gefälschten Mobilfunkbetreiber, der deterministische Antworten liefert, so dass Sie verstehen können, wie sich die API verhält. Für die Implementierung der API-Aufrufe werden wir Python verwenden.

Voraussetzungen

• A Vonage Entwickler-Konto.

• Python (>= 3.9) auf Ihrem System installiert ist.

Die in diesem Tutorial beschriebenen Schritte beziehen sich auf macOS oder Linux. Für Windows-Umgebungen werden ähnliche Befehle verwendet.

Vonage API-Konto

Um dieses Tutorial durchzuführen, benötigen Sie ein Vonage API-Konto. Wenn Sie noch keines haben, können Sie sich noch heute anmelden und mit einem kostenlosen Guthaben beginnen. Sobald Sie ein Konto haben, finden Sie Ihren API-Schlüssel und Ihr API-Geheimnis oben auf dem Vonage-API-Dashboard.

Sind Sie bereit, mit dem Bau zu beginnen?

Erleben Sie nahtlose Konnektivität, Echtzeit-Messaging und kristallklare Sprach- und Videoanrufe - alles auf Knopfdruck.

Eine neue Anwendung erstellen

Der erste Schritt ist die Erstellung einer neuen Anwendung mit "Netzwerk-RegisterFähigkeiten". Gehen Sie dazu zu Ihrem Dashboard und wählen Sie "Anwendungen" aus dem Menü auf der linken Seite.

Klicken Sie auf die Schaltfläche "Eine neue Anwendung erstellen"Schaltfläche. Geben Sie auf dem neuen Bildschirm einen Namen für Ihre Anwendung ein und klicken Sie auf "Öffentlichen und privaten Schlüssel generieren". Dadurch wird ein neues Schlüsselpaar erzeugt. Der öffentliche Schlüssel wird auf dem Dashboard angezeigt, während der private Schlüssel automatisch auf Ihren Computer heruntergeladen wird. Bewahren Sie den privaten Schlüssel sicher auf, da Sie ihn für die API-Authentifizierung benötigen.

Application properties

Gehen Sie als Nächstes zum Menüpunkt "Fähigkeiten" und suchen Sie den Abschnitt "Netzwerk-Register"Fähigkeit. Klicken Sie auf das Umschaltsymbol, um sie zu aktivieren, und wählen Sie "Spielplatz"Zugriffstyp. Da wir die SIM Swap API testen, werden wir das Feld Redirect nicht verwenden. Sie können es auf eine URL Ihrer Wahl einstellen (z. B. https://example.com/callback)

Network Registry dashboard configuration

Nachdem Sie die Anwendung erstellt haben, kopieren Sie die Anwendungs-ID die in der Zusammenfassung der Anwendung angezeigt wird. Sie werden diese später benötigen.

Was haben wir bis jetzt getan?

Wir haben eine Anwendung für den Zugriff auf die Netz-APIs im Playground-Modus entwickelt. Der Playground ist eine sichere, isolierte Umgebung, in der Entwickler APIs testen und mit ihnen interagieren können, ohne dass der ZDA die Nutzung der APIs genehmigt.

Innerhalb des Playgrounds können wir Live-Daten verwenden, indem wir die Telefonnummern von unterstützten CSPs zur Erlaubnisliste hinzufügen, oder gefälschte Daten mit einem virtuellen CSP verwenden, was uns erlaubt, die Netzwerk-APIs ohne Einschränkungen in Bezug auf die derzeit unterstützten Länder oder CSPs zu verwenden.

Einrichten der Umgebung

Öffnen Sie ein Terminal und erstellen Sie einen Ordner.

mkdir simswap-test

Erstellen Sie eine neue virtuelle Umgebung, um die Abhängigkeiten für unser Projekt zu installieren.

python -m venv .venvsource .venv/bin/activate

Zum Schluss installieren wir noch das Vonage Python SDKdas den Authentifizierungsfluss und die API-Aufrufe zu den Netzwerk-APIs vereinfacht:

pip install vonage==4.1.1

Die Umwelt ist bereit!

Authentifizierung

Es ist an der Zeit, mit dem Programmieren zu beginnen! Öffnen Sie Ihr bevorzugten Code-Editor und erstelle eine neue Datei namens simswap.py.

Beginnen wir mit dem Teil der Authentifizierung. Die SIM Swap API erfordert eine serverseitige (Backend-) Authentifizierung. Die Verwendung des SDK ist so einfach wie folgt:

from vonage import Vonage, Auth

auth = Auth(
       application_id='xxx-yyyy-zzzz',
       private_key='/path/to/my/private.key',
    )

vonage_client = Vonage(auth)

Wo anwendung_id und privater_schlüssel mit den Anmeldeinformationen der zuvor erstellten Anwendung übereinstimmen.

Implementierung der API-Aufrufe

Sobald unser auth Objekt fertig ist, können wir das Client-Objekt instanziieren und unseren ersten API-Aufruf durchführen. In diesem Beispiel rufen wir die prüfen Methode aus dem Objekt network_sim_swap auf, um zu überprüfen, ob die Telefonnummer in den letzten 500 Stunden mit einer neuen SIM-Karte verbunden wurde:

from vonage_network_sim_swap.requests import SimSwapCheckRequest

response = vonage_client.network_sim_swap.check(
    SimSwapCheckRequest(phone_number='+990491793')
)
print(response)
> {‘swapped’: True}

Da wir den Playground mit dem Virtual CSP verwenden, muss die Telefonnummer mit der 990 Vorwahl beginnen. Laut der Virtual CSP Dokumentationkönnen wir den max_value Argument ändern, um verschiedene Antworten zu erhalten:

• Für Werte kleiner als 500, check_sim_swap() zurück. false.

• Für Werte 500 oder höher, gibt die Methode true.

Sehen wir uns einige Beispiele an:

phone = '+99012345'
response = vonage_client.network_sim_swap.check(
   SimSwapCheckRequest(phone_number=phone, max_age=480)
 )
print(swapped)
> {‘swapped’: False}


phone = '+99012345'
response = vonage_client.network_sim_swap.check(
   SimSwapCheckRequest(phone_number=phone, max_age=501)
 )
print(swapped)
> {‘swapped’: True}

Vollständiger Quellcode

Die simswap.py Inhalt sollte wie folgt aussehen:

from vonage import Vonage, Auth
from vonage_network_sim_swap.requests import SimSwapCheckRequest

auth = Auth(
    application_id="xxxx-yyyy-zzzz",
    private_key="/path/to/your/private.key",
)

vonage_client = Vonage(auth)

try:
    response = vonage_client.network_sim_swap.check(
        SimSwapCheckRequest(phone_number='+990491234')
    )
    print(response)
except Exception as e:
    print(e)

Kontakt aufnehmen

Wenn Sie das Tutorial abgeschlossen haben, herzlichen Glückwunsch! Wir würden uns sehr über Ihr Feedback freuen! Schließen Sie sich uns auf dem Vonage Community Slack oder senden Sie uns eine Nachricht auf Xund wir werden uns bei Ihnen melden.

Vielen Dank fürs Lesen!