Open API Übersicht

Übersicht

PlanRadar bietet sichere REST-APIs, die allen Kunden für ihre eigenen Integrationen zur Verfügung stehen.
Darüber hinaus bietet PlanRadar auch PlanRadar Connect, um benutzerdefinierte Automatisierungen und Integrationen mit Anwendungen von Drittanbietern ohne Programmierung zu erstellen. 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

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

1. Klicken Sie auf Einstellungen
2. Klicken Sie auf API-Dokumentation
3. Geben Sie Ihr Passwort ein
4. Klicken Sie auf Bestätigen
   

   

5. Wählen Sie das Feature , deren APIs Sie anzeigen möchten
   

   

6. Es wird eine Liste aller APIs angezeigt, die mit diesem Feature verbunden sind
   

   

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:

  {
    "Daten": {
      "Attribute": {
        "name": "Ihr Projektname"
      }
    }
  }

Text der Antwort:

  {
    "Daten": {
      "id": "aqbqod",
      "type": "projekte",
      "Attribute": {
        "id": "aqbqod",
        "name": "Ihr Projektname",
        "homepage": "",
        "Land": null,
        "Projektnummer": null,
        "Beschreibung": null,
        "Stadt": null,
        "Postleitzahl": null,
        "Straße": null,
        "autor-id": "pxpp",
        ...
      }
    }
  }

Zentrale API-Konzepte

Erfahren Sie mehr über die grundlegenden Konzepte hinter unseren APIs. Lesen Sie mehr unter Zentrale API-Konzepte.

API-Tutorials

Entdecken Sie Schritt-für-Schritt-Tutorials zur Verwendung unserer APIs in den folgenden Bereichen:

API-Tutorials für Benutzer-Endpunkte

API-Tutorials für Projekt-Endpunkte

API-Tutorials für Ticket-Endpunkte

API-Tutorials für Dokument-Endpunkte

API-Tutorials für Projektplan-Endpunkte

API-Changelog

Informieren Sie sich über die neuesten Updates und Änderungen an unseren APIs. Lesen Sie mehr unter API Changelog.