Open APIs – PlanRadar HelpCenter

Übersicht

PlanRadar bietet sichere REST-APIs, die allen Kunden für ihre eigenen Integrationen offen stehen. Darüber hinaus bietet PlanRadar auch PlanRadar Connect an, mit dem Sie eigene Automatisierungen und Integrationen mit Anwendungen von Drittanbietern ohne Programmieraufwand erstellen können. Lesen Sie mehr unter PlanRadar Connect.

Die REST-API verfügt über ressourcenorientierte URLs, akzeptiert formularcodierte Anfragekörper, gibt JSON-codierte Antworten zurück und verwendet standardmäßige HTTP-Antwortcodes und Authentifizierung.

Zugang & Berechtigungen

Open APIs sind nur für Pro- und Enterprise-Accounts verfügbar. Lesen Sie mehr unter Preise und Abonnement.

Um die Open APIs zu nutzen, benötigen Sie einen In-House Benutzer mit der Benutzerberechtigung 'API-Zugriff'. Lesen Sie mehr unter Berechtigungen.

Verwendung von Open APIs

Wenn Sie die APIs verwenden, können Sie bis zu 30 Anfragen pro Minute senden. Wenn Sie dieses Limit überschreiten, wird Ihr Autorisierungs-Token für 5 Minuten deaktiviert. Bei besonderen Anforderungen kontaktieren Sie bitte unser Support-Team.

API Zugriffsberechtigung

Wenn Sie eine API nutzen, müssen Sie den Autorisierungsschlüssel als Header-Wert von "X-PlanRadar-API-Key" hinzufügen. Den Autorisierungsschlüssel erhalten Sie, indem Sie Personal Access Tokens generieren und diese zur Authentifizierung Ihrer API-Anfragen verwenden.

Verfügbare APIs

Klicken Sie auf Einstellungen
Klicken Sie auf API-Dokumentation
Geben Sie Ihr Passwort ein
Klicken Sie auf Bestätigen Sie
Wählen Sie das Feature aus, deren APIs Sie anzeigen möchten
Es erscheint eine Liste aller APIs, die mit diesem Feature verbunden sind

Wir arbeiten derzeit daran, alle unsere APIs auf v2 zu aktualisieren. Wir empfehlen, die v2-APIs zu verwenden, wenn sie verfügbar sind. Die V2-APIs sind schneller, robuster und flexibler als die v1-APIs.

Beispiel einer API-Anfrage

Hier sehen Sie ein Beispiel für die Verwendung von APIs zum Abrufen von Projektdetails:

API-URL:

GET /api/v1/{Kunden_id}/Projekte

Text der Anfrage:

{
  "data": {
    "attributes": {
      "name": "Ihr Projektname"
    }
  }
}

Text der Antwort:

{
  "data": {
    "id": "aqbqod",
    "type": "projects",
    "attributes": {
      "id": "aqbqod",
      "name": "Your Project Name",
      "homepage": "",
      "country": null,
      "projectnumber": null,
      "description": null,
      "city": null,
      "zipcode": null,
      "street": null,
      "author-id": "pxpp",
      ...
    }
  }
}

Verwandete Artikel

Webhooks einrichten