BI API - Beispielanwendung mit Postman/Excel

Mit dieser Beispielanwendung möchten wir Ihnen zeigen, wie einfach Sie Ihre BI Daten via BI API in eine externe Anwendung laden und dort damit weiterarbeiten können.

Für die Erstellung der gewünschten Abfrage verwenden wir die API-Software Postman.

Die BI Daten schliesslich laden wir in Microsoft Excel, wo sie sich dann per Knopfdruck jederzeit automatisch aktualisieren lassen.

Eine BI API Abfrage erstellen

Um die BI API Abfrage nicht von Hand erstellen zu müssen (im Artikel BI API finden Sie dazu alle notwendigen Parameter sowie auch Beispiel-URLs), verwenden wir dafür ein Tool, in unserem Beispiel Postman.

Öffnen Sie Postman und klicken Sie auf das +:

Ins Feld GET fügen Sie eine Beispiel BI API URL ein. Diese setzt sich wie folgt zusammen:

• Ihre Vertec Server URL
• Einen Beispielanhang: /api/bi/getdata?f=json&measures=minutesint,minutesext&dimension0=Projekt&startDate=2021-07-01&endDate=2021-12-31

Es kommt dabei noch nicht darauf an, wie die Abfrage lautet, Sie können einfach diese Beispiel URL eingeben. Sobald Sie diese eingeben, werden die enthaltenen Parameter automatisch angezeigt. Damit können Sie später weiterarbeiten:

Vertec Autorisierung hinterlegen

Unter Authorization hinterlegen Sie Ihr Vertec API Token. Wählen Sie dafür Bearer Token:

Vertec Versionen vor 6.6

In Vertec Versionen vor 6.6 erfolgte die Autorisierung via Basic Auth > Vertec Login und Passwort. Ab Vertec 6.6 wird dafür das API Token verwendet. Aus Gründen der Rückwärtskompatibilität wird die Anmeldung via Login und Passwort noch unterstützt, mit Vertec 6.7 jedoch abgeschaltet. Bis dann müssen Sie Ihre Abfragen also entsprechend umstellen.

Sobald Sie die Autorisierung hinterlegt haben, klicken Sie auf Send. Ihre Daten werden geladen und unterhalb angezeigt:

Dadurch sehen Sie, dass alles richtig eingegeben wurde.

Nun können Sie hier im Postman weitere Parameter anfügen, indem Sie den Cursor ins Feld Key setzen und zu tippen beginnen:

Welche Parameter zur Verfügung stehen, finden Sie im Abschnitt getdata im Artikel BI API.

Sobald Sie erneut auf Send klicken, werden die Daten mit den neuen Parametern geladen und angezeigt.

Stellen Sie sich so die URL zusammen, welche Sie im externen Programm später verwenden möchten. Für unser Beispiel haben wir die folgende Abfrage zusammengestellt. Achten Sie dabei auf das Format, welches das externe Programm verlangt. Für Excel stellen wir das Format (Parameter f) auf csv um:

Diese URL können Sie sich nun rauskopieren:

In unserem Beispiel lautet sie:

/api/bi/getdata?f=csv&measures=minutesint,minutesext&dimension0=Projekt&startDate=2021-07-01&endDate=2021-12-31&dimension1=Projektbearbeiter&dimension0_Projekttyp=typ

Daten in MS Excel laden

Nun laden wir diese Abfrage in Microsoft Excel. Klicken Sie dafür auf Daten > Daten abrufen und transformieren > Aus dem Web (die Begriffe können je nach Sprache und Version leicht variieren):

Nun erscheint folgender Dialog:

• Wählen Sie Weitere
• Fügen Sie die oben kopierte URL ein
• Beim Parameter des HTTP Anforderungsheaders geben Sie im Feld links Authorization ein. Dieser Text muss manuell eingetippt werden.
• Im Feld rechts geben Sie (ebenfalls manuell) Bearer ein und fügen dann Ihr API Token ein.

Klicken Sie auf OK. Beim ersten Ausführen erscheint noch folgender Dialog:

Klicken Sie hier auf Verbinden.

Nun erscheint das Vorschaufenster mit den Daten. Wichtig ist hier, dass Sie die Kodierung auf UTF-8 umstellen:

Wenn Sie nun auf Laden klicken, werden die Daten in die Arbeitsmappe eingefügt.

Damit können Sie nun weiterarbeiten, Look-ups, Pivot-Tabellen etc. erstellen.

Die Daten können Sie über Daten > Alle aktualisieren jederzeit erneut aus Vertec laden:

Anmeldedaten nachträglich ändern

Falls Sie nachträglich etwas an den Anmeldedaten ändern müssen, sind diese hier hinterlegt: Daten > Daten abrufen > Datenquelleneinstellungen:

Anmeldung via API Token

1. Berechtigungen bearbeiten > Anmeldeinformationen bearbeiten > Anonym:

   

2. Daten aus dem Web > Weitere > Parameter des HTTM Anforderungsheaders setzen (siehe oben)

Anmeldung via Loginname + Passwort

Berechtigungen bearbeiten > Anmeldeinformationen bearbeiten > Standard.

Diese Art der Anmeldung funktioniert nur noch bis Vertec Version 6.7. Wir empfehlen, schon jetzt die Anmeldung per API Token zu verwenden.