ProjectSight API

Für eine optimale Darstellung öffnen Sie die PDF-Datei in einem Browser.

Sie können die ProjectSight API verwenden, um Informationen in Ihren Portfolios und Projekten anzuzeigen und zu aktualisieren. Um Zugriff zu erhalten, senden Sie eine E-Mail an ProjectSightAPISupport@trimble.com.

Nachdem Sie Ihre Anwendung registriert haben, können Sie sie bei der API anmelden und dann ein Sicherheits-Token erwerben. Das Token ist mit Ihren Trimble-Kontodaten verknüpft und ist für den in der Token-Antwort definierten Zeitraum gültig.

  1. Melden Sie sich mit Ihrem Trimble-Konto bei API Cloud an.
  2. Wählen Sie auf der Seite Discover API ProjectSight oder ProjectSight-EU aus.
  3. Wählen Sie Subscriptions.
  4. Wählen Sie im Abschnitt Create Subscription Ihre Anwendung aus und wählen Sie dann Subscribe.
    5. Abonnement erstellen
  1. Wählen Sie in API Cloud ProjectSight oder ProjectSight-EU.
  2. Wählen Sie Get Key.
  3. Kopieren Sie die folgenden Werte:
    • Application Name
    • Consumer Key
    • Consumer Secret
    • Package & Usage Plan Key
    Schlüsselinfo erwerben
  4. Um ein Sicherheits-Token von Trimble Identity zu erhalten, senden Sie eine Anfrage an https://id.trimble.com/oauth/token mit den folgenden Informationen:
    • Header: Authorization

      • Wert: Basic Key

      Der Schlüssel im Autorisierungswert ist eine einzelne Zeichenfolge, die aus dem Kundenschlüssel und dem Kunden-Secret besteht, getrennt durch einen Doppelpunkt (Kundenschlüssel:Kunden-Secret) und dann Base64-encoded.

    • Header: Content-Type

      • Wert: application/x-www-form-urlencoded

    • Text:

      • grant_type=client_credentials

      scope=[Anwendungsname]

      Ersetzen Sie [Anwendungsname] durch den im vorherigen Schritt kopierten Wert.

      Beispiel:

      POST https://id.trimble.com/oauth/token/
      Authorization: Basic TE9pU...
      Content-Type: application/x-www-form-urlencoded
      Accept: application/json
      Cache-Control: no-cache

      grant_type=client_credentials
      scope=Trimble-ProjectSightApp1

    • Wenn die Anfrage erfolgreich ist, enthält die Antwort eine Json-Klasse mit mehreren Eigenschaften.
      • Die Eigenschaft access_token wird für die API-Aufrufe verwendet.
      • Die Eigenschaft expires_in legt fest, wie viele Sekunden das Token gültig ist.
    • Wenn die Anfrage fehlschlägt, enthält die Antwort zwei Felder (error und error_descriptionn), die das Problem beschreiben.
  1. Wählen Sie in API Cloud ProjectSight oder ProjectSight-EU.
  2. Weitere Informationen über die API-Endpunkte finden Sie in der Entwicklerdokumentation.
    • Um den URL zu finden, den Sie für den Zugriff auf die API für Ihre Anwendung verwenden werden, wählen Sie API-Endpoint.
      • URL für den API-Zugriff
  1. Bitten Sie den Trimble Support, eine neue Anwendung in API Cloud zu erstellen.
  2. Abonnieren Sie die neue Anwendung, und verwenden Sie ihren Kundenschlüssel und ihr Kunden-Secret für Ihre ProjectSight-Integrationen.
    1. Melden Sie sich bei API Cloud an, und wählen Sie ProjectSight oder ProjectSight-EU.
    2. Wählen Sie die Registerkarte Subscriptions.
    3. Wählen Sie im Abschnitt Create Subscription die neue Anwendung aus und wählen Sie dann Subscribe.
      4. API abonnieren
    4. Wählen Sie Get Key.
      5. Schlüssel abrufen
    5. Um den Kundenschlüssel und das Kunden-Secret für die neue Anwendung anzuzeigen und zu kopieren, wählen Sie die neue Anwendung in der Liste aus.
      6. Schlüssel und Secret kopieren
    6. Aktualisieren Sie Ihre ProjectSight-Integrationen mit dem neuen Kundenschlüssel und dem Kunden-Secret.

      7. Package & Usage Plan Key (d. h., x-api-key HTTP-Header) ändert sich nicht. Nur der Kundenschlüssel und das Kunden-Secret sind für jedes Anwendungsabonnement eindeutig.

  3. Um das Abonnement für die alte Anwendung zu entfernen, wählen Sie neben der alten Anwendung die Option Revoke Key.
    4. Schlüssel des alten Abonnements widerrufen

Durchsatzbegrenzung

Gemäß der aktualisierten Anleitung von Trimble Cloud müssen Sie den x-API-Schlüssel nicht an die trimblepaas.com-Endpunkte übergeben. Andernfalls gibt es eine Begrenzung auf 50 Anfragen pro Sekunde.

Unterstützte Funktionen

Die folgenden Datensatztypen werden unterstützt:

  • Konto
  • Aktionspunkt
  • Zahlungsantrag
  • Budget
  • Budget-Codestruktur
  • Budgetgruppe
  • Budget-Momentaufnahme
  • Änderungswunsch
  • Checkliste
  • Firma
  • Auftrag
  • Auftragsrechnung
  • Tagesbericht
  • Zeichnung
  • Zeichnungssatz
  • Arbeitsanweisung
  • Datei
  • Ordner
  • Prognose
  • Allgemeine Rechnung
  • Problem
  • Projektkosten
  • Auswahlliste
  • Meeting
  • Aufforderung/Mitteilung
  • Foto
  • Bestellkatalog
  • Portfolio
  • Potenzieller ÄA
  • Primärvertrag-ÄA
  • Projekt
  • Mängelliste
  • Bestellung
  • Datensätze
  • Berichtsgenerator
  • IA
  • Rolle
  • Sicherheitsmitteilung
  • Subunternehmer-ÄA
  • Einreichung
  • Einreichungspaket
  • Übermittlung
  • Benutzer
  • Workflow-Status

Für die unterstützten Datensatztypen sind die folgenden API-Operationen verfügbar:

  • Datensatz abrufen
  • Datensatz löschen
  • Sammlung von Datensätzen abrufen
  • Datensatz erstellen oder aktualisieren
  • Sammlung von Datensätzen basierend auf einer Abfrage abrufen
  • Workflow-Status für Datensätze abrufen
  • Liste verfügbarer Berichte abrufen
  • Liste verfügbarer UDFs abrufen

Einige Datensatztypen haben unterschiedliche Operationen.