API-Integration

Inhaltstyp: Sammlung von Anleitungen

Zielgruppe: Entwickler, technische Administratoren

Gilt für: TBM Studio- 12.0 en und höher

Voraussetzungen: API-Anmeldedaten, Programmierkenntnisse, Netzwerkzugriff auf TBM Studio

Übersicht

Die TBM Studio Platform API ermöglicht die programmgesteuerte Automatisierung von Daten-Uploads und -Downloads. Dieser Abschnitt enthält Anleitungen zur Integration Ihrer Systeme in TBM Studio mithilfe der REST-API, einschließlich Authentifizierung, Datenoperationen und produktionsreifen Mustern zur Fehlerbehandlung.

Die API stellt über einfache Befehle vom Typ „ HTTP “ eine direkte Verbindung zwischen Ihren Unternehmensdatensystemen und TBM Studio her. Sie können diese Befehle mit minimalem Aufwand in Job-Scheduler, ETL-Tools oder benutzerdefinierte Anwendungen integrieren – eine zusätzliche Softwareinstallation ist nicht erforderlich.

Hinweis: Bei der Release- 12.9 ion und höher müssen bei allen API-Aufrufen die folgenden Header angegeben werden: app-type="Flagship" und app-version="NA"

Die Wahl der Integrationsmethode

TBM Studio bietet verschiedene Integrationsansätze an. Nutzen Sie diesen Entscheidungsleitfaden, um die richtige Methode für Ihren Anwendungsfall auszuwählen.

Methode Am besten geeignet für Erfordert
Plattform-API Maßgeschneiderte Integrationen, ETL-Tools von Drittanbietern, Umgebungen, in denen keine lokalen Agenten installiert werden können Kenntnisse in der Skriptsprache, API-Zugangsdaten
DataLink (Klassisch) Datenladen per Mausklick, auch für Nutzer ohne Programmierkenntnisse DataLink Agent-Installation, „ DataLink “-Lizenz
Veröffentlichte Tabellen Exportieren von Modelldaten in externe BI-Tools ( Power BI, Tableau ) TBM Studio 12.11.3 und höher, Berichtskonfiguration

Verwenden Sie die Plattform-API, wenn:

  • Sie können keinen lokalen „ DataLink “-Agenten installieren, um Daten aus lokalen Quellen hochzuladen
  • Sie möchten eingebettete Skripte in einem ETL-Tool eines Drittanbieters verwenden
  • Sie müssen das Laden von Daten über unternehmensweite Job-Scheduler automatisieren
  • Sie benötigen programmatische Kontrolle über Datenoperationen

Verwenden Sie veröffentlichte Tabellen, wenn:

  • Sie müssen die vom Modell berechneten Daten in externe Systeme exportieren
  • Sie benötigen ein stabiles Schema für die Nutzung durch nachgelagerte BI-Tools
  • Sie benötigen einen kontrollierten Datenausgang mit Governance

Weitere Informationen finden Sie unter „Benutzerauthentifizierung über APIs “.