Download

Die NFON Service Portal Application Programming Interface (API)

Neu: Postman-Sammlung

  • NFON bietet eine umfassende Postman Request-Sammlung, die alle verfügbaren Endpunkte mit mehr als 350 vordefinierten Anforderungsbeispielen demonstriert. Sie kann zusammen mit einer Beispiel-Postman-Umgebung unter dem aktuellen Speicherort der Service Portal API Postman Collection heruntergeladen werden (bitte mit der rechten Maustaste anklicken und als Datei herunterladen).

  • Hinweis: Bevor Sie ein neues Support-Problem melden, probieren Sie bitte zunächst die entsprechenden Anfragen mit dieser Sammlung aus und fügen Sie die Postman-Ausgabe Ihrer Supportanfrage bei. So können wir Ihr Problem besser untersuchen und diese Sammlung im Laufe der Zeit weiter verbessern, damit wir möglichst viele Anwendungsfälle in dieser Sammlung abdecken.

  • Weitere Informationen zur Verwendung dieser Sammlung finden Sie unten.

Beta-Programm

Der Support und die Verfügbarkeit der API, die Kunden im Rahmen des BETA-Programms zur Verfügung gestellt wird, werden nach bestem Wissen und Gewissen bereitgestellt.

Wenn Sie die API nutzen möchten, müssen Sie über den NFON-Support einen API-Schlüssel anfordern, der nur im Beta-Status verfügbar ist. Bevor Sie sich an den NFON-Support wenden, laden Sie bitte eines der folgenden Dokumente herunter, füllen Sie es aus und legen Sie es Ihrer Anfrage an unser Support-Team bei:

Die NFON-API ist als RESTful-Webdienst verfügbar. NFON bietet mehrere APIs. Die Service Portal API (SPA) ist auf die Account-K-Ebene zugeschnitten. Einige Anwendungsfälle zur Veranschaulichung der Leistungsfähigkeit der Service Portal API (SPA) sind

  • Bereitstellung großer Mengen an Erweiterungen

  • Active Directory-Interoperabilität

  • Interaktive Erstellung und Verwaltung von Konferenzbrücken

  • Andere Verwaltungstools von Drittanbietern zur automatischen Verwaltung des PBX-K-Anlage

Verwendung der Postman-Sammlung

  • Laden Sie die neueste Service Portal API Postman-Sammlung herunter
    Möglicherweise müssen Sie mit der rechten Maustaste auf den Link klicken und Herunterladen auswählen oder einfach den angezeigten Seiteninhalt in einer Datei speichern.

  • Laden Sie die neueste Postman-Beispielumgebung herunter

  • Installieren und starten Sie Postman
    1. Importieren Sie die Service Portal API-Sammlung in Postman.
    2. Importieren Sie die Beispielumgebung auf die gleiche Weise wie die Sammlung.

  • Bearbeiten Sie die Umgebung
    1. Wichtiger Hinweis: Verwenden Sie nur die Spalte Aktueller Wert. Achten Sie darauf, NICHT die Spalte Anfangswert zu verwenden, da diese in der Postman Cloud freigegeben ist und Sie Ihren API-Schlüssel auf keinen Fall in der Cloud freigeben möchten.
    2. Legen Sie den apiKey fest

    3. Legen Sie den apiSecret fest

    4. Legen Sie die customerId (Kxxxx, Sxxxx, Cxxxx) fest

    5. Optional: Legen Sie die baseUrl fest

  • Testen Sie die API
    1. Gehen Sie zu Allgemein -> API-Version
    2. Klicken Sie auf Senden.

    Wenn Sie die Fehlermeldung 403 Forbidden erhalten, ist eine der Umgebungsvariablen nicht korrekt eingestellt oder die Umgebung wurde nicht ausgewählt.

    3. Probieren Sie Targets -> „/api/customers/{{customerId}}/targets/“ aus.

    Sie sind fertig!

  • Falls Sie Schwierigkeiten bei der Verwendung der Sammlung haben, wenden Sie sich bitte an den Support.