Integracja z interfejsem API

Edytuj online

Typ treści: Zbiór poradników

Grupa docelowa: programiści, administratorzy techniczni

Dotyczy: TBM Studio w wersji 12.0 i nowszych

Wymagania wstępne: dane uwierzytelniające do API, znajomość programowania, dostęp sieciowy do TBM Studio

Przegląd

Interfejs API platformy TBM Studio umożliwia automatyzację przesyłania i pobierania danych za pomocą kodu. W tej sekcji znajdziesz instrukcje dotyczące integracji Twoich systemów z TBM Studio za pomocą interfejsu API REST, w tym informacje na temat uwierzytelniania, operacji na danych oraz gotowych do wdrożenia w środowisku produkcyjnym schematów obsługi błędów.

Interfejs API zapewnia bezpośrednie połączenie między systemami danych Twojej firmy a TBM Studio za pomocą prostych poleceń typu „ HTTP ”. Polecenia te można zintegrować z harmonogramami zadań, narzędziami ETL lub aplikacjami własnymi przy minimalnym nakładzie pracy — nie jest wymagana instalacja żadnego dodatkowego oprogramowania.

Uwaga: W przypadku wersji 12.9 i nowszych należy dołączać następujące nagłówki do wszystkich wywołań API: app-type="Flagship" oraz app-version="NA"

Wybór metody integracji

TBM Studio oferuje różne sposoby integracji. Skorzystaj z tego przewodnika, aby wybrać metodę najlepiej odpowiadającą Twoim potrzebom.

Metoda Najlepsze dla Wymaga
Interfejs API platformy Integracje niestandardowe, narzędzia ETL innych producentów, środowiska, w których nie można zainstalować agentów lokalnych Umiejętności w zakresie tworzenia skryptów, dane uwierzytelniające do API
DataLink (Klasyczne) Ładowanie danych metodą „wskaż i kliknij” – użytkownicy bez umiejętności programowania DataLink Instalacja agenta, licencja typu „ DataLink ”
Opublikowane tabele Eksportowanie danych modelu do zewnętrznych narzędzi BI ( Power BI, Tableau ) TBM Studio 12.11.3 i nowsze wersje, konfiguracja raportów

Z API platformy należy korzystać, gdy:

  • Nie można zainstalować lokalnego agenta usługi „ DataLink ” w celu przesyłania danych ze źródeł lokalnych
  • Chcesz korzystać ze skryptów wbudowanych w narzędziu ETL innego producenta
  • Należy zautomatyzować wczytywanie danych za pomocą korporacyjnych systemów planowania zadań
  • Potrzebujesz programowej kontroli nad operacjami na danych

Z tabel opublikowanych należy korzystać, gdy:

  • Należy wyeksportować dane obliczone przez model do systemów zewnętrznych
  • Potrzebujesz stabilnego schematu danych do wykorzystania w narzędziach BI
  • Potrzebujesz kontrolowanego przepływu danych wychodzących wraz z odpowiednim systemem zarządzania

Więcej informacji można znaleźć w sekcji „Uwierzytelnianie użytkowników za pomocą interfejsów API ”.