Die API Proactive Connect ermöglicht die nahtlose Anbindung externer Systme, beispielsweise von ITSM-/Ticketsystemen oder Reporting-Lösungen. Sie schafft eine einheitliche Schnittstelle, über die Daten effizient ausgetauscht und integriert werden können.

Im Folgenden finden Sie eine Anleitung, wie Sie die API konfigurieren und API-Clients anlegen.

Aktivieren des API-Zugriffs

Wählen Sie zuerst die gewünschte Firma aus, für die die API aktiviert werden soll. Klicken Sie anschließend rechts auf den Reiter API-Zugriff. Sofern der API-Zugriff für diese Firma noch nicht aktiviert ist, erscheint dort die oben im Bild sichtbare Meldung. Klicken Sie hier auf API-Zugriff anpassen.

Klicken Sie auf den Schalter, um den API-Zugriff für diese Firma zu aktivieren und speichern Sie anschließend.

Hinweise: Der gelb hinterlegte Hinweis für den inaktiven Zustand warnt Sie davor, eine Firma mit aktivem API-Zugriff unbedacht auf inaktiv zu setzen. Der Hinweis, der erscheint, sobald Sie den API-Zugriff auf aktiv setzen, warnt davor, dass der API-Zugriff auch für alle geteilten Firmen gilt, die ebenfalls den API-Zugriff aktiviert haben.

Einen neuen API-Client erstellen

Um einen neuen API-Client zu erstellen, klicken Sie nach Aktivieren des API-Zugriffs rechts oben auf + Neuer API-Client.

SICHERHEITSWARNUNG
	Es ist dringend empfohlen, für jedes externe System, das Zugriff auf die Proactive-Hub-Daten braucht, einen eigenen (separaten) API-Client anzulegen. Nutzen Sie aus Sicherheitsgründen nie einen API-Client für mehrere Systeme.

Geben Sie für den API-Client einen aussagekräftigen Namen ein. Der Name dient ausschließlich der leichteren Erkennbarkeit in der Administrationsoberfläche.

Klicken Sie auf Speichern und warten Sie ab, bis das System den API-Client erzeugt hat (es erscheint so lange ein Ladebalken am oberen Ende der Applikation). Dieser Prozess kann bis zu einer Minute dauern.

Das darauffolgende Fenster zeigt Ihnen die vom System erstellte Client-ID sowie das Client Secret.

ACHTUNG
	Kopieren Sie sich unbedingt das Client Secret an dieser Stelle an einen sicheren Ort. Es wird später nicht mehr angezeigt und kann nicht nachträglich kopiert werden. Beachten Sie auch, dass jeder im Besitz des Client Secret Zugriff auf Ihre Daten erhalten kann.

Schließen Sie anschließend das Fenster. Sie sehen jetzt rechts in einer Liste Ihre bisher angelegten API-Clients mit ihrem Status, der Client ID, dem Applikationsnamen, durch wen sie angelegt wurden und zu welchem Zeitpunkt sowie wann sie ablaufen und zuletzt verwendet wurden. Über das Drei-Punkte-Menü am Ende jeder Zeile haben Sie die Optionen:

• die Details des API-Clients zu öffnen,

• das Client Secret zu erneuern (Achtung: Die Erneuerung des Client Secrets kann nicht rückgängig gemacht werden!)

• dem API-Client Umgebungen zuzuweisen (öffnet ein eigenes Fenster zum Zuweisen für Umgebungen und Umgebungsrollen)

• und den API-Zugriff zu widerrufen (den API-Client zu löschen).

Zuweisen von Umgebungen und Rollen

Um auf den Screenshot unten zu kommen, wählen Sie in der Liste aller APIs der Firma eine aus und klicken Sie sie an. Sie sehen die Liste anschließend auf der linken Seite.

HINWEIS
	Durch Klicken auf den Eintrag in der Spalte Client ID wird diese in die Zwischenablage kopiert. Bei Klick auf den Inhalt der anderen Spalten öffnen sich die Details wie auf dem Bild.

Hier haben Sie ebenfalls die Möglichkeit, in den Details zum API-Client durch Aktivieren des Schalters mit dem Schlüssel-Icon dem Client Umgebungen hinzuzufügen und die gewünschte Umgebungsrolle auszuwählen.