Wissensdatenbank – Software-Integration anhand von API

 

Inhalt:

  1. Interaktive API-Dokumentation
  2. Verwalten Ihrer Personal Access Token
  3. Verwalten von Webhooks für Ihr Konto
  4. Benutzern die Berechtigung zum Zugriff auf die API-Funktionen erteilen

 

Software-Integration anhand von API

PlanRadar bietet eine Web-API (Application Programming Interface) und Webhooks. Auf diese Weise können Sie Ihre Software oder kundenspezifische Software von Drittanbietern in Ihr PlanRadar-Konto integrieren.

Die Verwendung der API erfordert Kenntnisse in der Softwareentwicklung. Bitte beziehen Sie für die Einrichtung der API und den Zugriff ein Softwareentwicklungsteam ein. Leider ist PlanRadar nicht in der Lage, kundenspezifische Softwareentwicklung im Auftrag unserer Kunden anzubieten.

 

Interaktive API-Dokumentation

Bevor Sie fortfahren, vergewissern Sie sich bitte, dass Sie über die erforderlichen Berechtigung für den Zugriff auf die API-Funktionen verfügen. Über Einstellungen > API-Dokumentation können Sie dann auf die API-Dokumentation zugreifen:

 

Sie können alle Endpunkte direkt testen. Für einige Endpunkte müssen Sie eine Projekt-ID oder eine Ticket-ID angeben, die Sie normalerweise in der URL finden und von dort kopieren können, wenn Sie das spezifische Projekt oder Ticket anzeigen.

Sie haben außerdem die Möglichkeit, einen Curl-Befehl zu kopieren und einzufügen und die API über die Befehlsshell zu testen. Sie benötigen jedoch ein Access Token, das im nächsten Abschnitt beschrieben wird.

 

Verwalten Ihrer Personal Access Token

Anhand von Personal Access Token kann sich externe Software bei der Verwendung einer API bei unseren Servern authentifizieren.

Bevor Sie fortfahren, vergewissern Sie sich bitte, dass Sie über die erforderlichen Berechtigung für den Zugriff auf die API-Funktionen verfügen. Personal Access Token können Sie unter Einstellungen > Profil > Personal Access Tokens erstellen und verwalten.

 

Diese Token sind benutzerspezifisch, d.h. Sie sollten sie nicht mit anderen Personen teilen und sorgfältig damit umgehen. Falls Unbefugte in den Besitz eines Access Token gelangen, könnten sie potenziell auf Ihr Konto zugreifen und in Ihrem Namen handeln.

 

Standardmäßig ist die Zahl der Abfragen auf 30 pro Minute begrenzt. Auf Anfrage unter [email protected] kann dieses Limit erhöht werden.
 

Verwalten von Webhooks für Ihr Konto

Anhand von Webhooks kann externe Software auf Ereignisse reagieren, die innerhalb von PlanRadar auftreten, wie z.B. „Ticket erstellt“, „Ticket aktualisiert“, „Foto angehängt“ usw. Sie können Webhooks unter Einstellungen > Account > Webhooks erstellen und verwalten.

Diese Einstellung ist nur für Anwender mit Account zugänglich.

 

Klicken Sie auf ‘Add new Webhook’. Hier können Sie auswählen, über welche Ereignisse Ihre externe Software benachrichtigt werden soll.

 

Authentication:
Hier konfigurieren Sie, wie wir uns bei Ihrem Server authentifizieren können. Derzeit unterstützen wir „HTTP Basic Authentication“ mit Benutzername und Passwort.

 

Headers:
Wenn Sie zusätzliche Header-Felder für Ihren Dienst bereitstellen möchten, können Sie diese hier konfigurieren. Für Passwörter und andere persönliche Zugangsdaten bieten wir die Möglichkeit, die Angabe in der Benutzeroberfläche auszublenden. Wenn Sie sich für Ausblenden entscheiden, können Sie die Angabe nach dem Speichern Ihres Webhooks aus Sicherheitsgründen nicht mehr in der Benutzeroberfläche aufrufen.

 

Benutzern die Berechtigung zum Zugriff auf die API-Funktionen erteilen

Die Seiten API-Dokumentation und Personal Access Tokens können nur mit den korrekten Kundenberechtigungen aufgerufen werden. Anwendern mit Account wird automatisch der Zugang zur API-Dokumentation gewährt.

Um anderen internen Benutzern die entsprechenden Berechtigungen zu erteilen, wechseln Sie zu Benutzerverwaltung > Benutzer und bearbeiten oder erstellen Sie einen neuen In-House Benutzer und markieren Sie die Berechtigung API Access.

 

Access Token anderer Benutzer ungültig machen

Sie haben die Möglichkeit, von anderen internen Benutzern erstellte Access Token zu entfernen. Um Access Token zu löschen, müssen Sie dazu berechtigt sein, Benutzer zu verwalten. 

Um ein von einem Benutzer erstelltes Access Token zu entfernen, wechseln Sie über die Navigationsleiste zu Benutzerverwaltung > Benutzer. Wählen Sie hier den In-House Benutzer aus, dessen Token Sie aus dem System entfernen möchten. Auf der rechten Seite sehen Sie die vom Benutzer erstellten Token, und von hier aus können Sie diese löschen.  

 

Hinweis: Von Accountinhabern erstellte Access Token können nicht von anderen Benutzern gelöscht werden. Sprich: Access Token von Anwendern mit Account können nur von den Accountinhabern gelöscht werden, und zwar über Einstellungen > Profil > Personal Access Token. 

Zurück zum Inhaltsverzeichnis.