Administration

Owned by Timm Stelzer (Unlicensed)
Last updated: Aug 11, 2021
4 min read

Die API benutzen

Unsere Administration stellt eine interaktive Schnittstelle zu unserer programmatischen API zur Verfügung. Ein angemeldeter Administrator kann über den Menüpunkt Schnittstelle > Dokumentation beliebige Endpunkte aufrufen:

Die API ist unterteilt in Kategorien (1) und Endpunkte (2):

Um die einzelnen Endpunkte anzurufen, folgen Sie diesen Schritten:

  1. (Falls nicht bereits aufgeklappt), klappen Sie die Kategorie auf.

  2. Klappen Sie einen Endpunkt auf.

  3. Klicken Sie auf Try it out, bestimmen Sie die Parameter (in vielen Fällen müssen diese nicht angepasst werden), und klicken Sie auf Execute.

     

  4. Die Ergebnisse sind nun unterhalb, in der Sektion Responses sichtbar. Daten sind im Video aus Datenschutzgründen unkenntlich gemacht.

Archive herunterladen

Zur Anschauung individueller Archive, zum Test, oder zur Prüfung, können diese in der Administration heruntergeladen werden.

Beliebiges Archiv herunterladen

Um ein beliebiges, neues Archiv herunterzuladen, benötigen wir zunächst die ID eines willkürlichen Archives. Im ersten Schritt fragen wir eine Liste aller verfügbaren Archive ab, und kopieren die ID eines Archives, um diese dann im letzten Schritt für den Download zu nutzen.

  1. Unter der Kategorie Archive, klappen Sie den Endpunkt GET /communication/archives/archives auf (1), und setzen den status Parameter auf AVAILABLE (2). So werden nur Archive angezeigt, die auch zur Verfügung stehen:

     

  2. Klicken Sie auf Execute. Damit wird die Anfrage ausgeführt.

  3. Scrollen Sie zu den Responses, dort sollten die Resultate als Text aufgeführt sein. Falls die Liste leer ist, sind noch keine Archive auf der Plattform vorhanden, und müssen erst erstellt werden.

  4. Lassen Sie sich von der Datenstruktur nicht beirren, hier kann viel ignoriert werden. Die Daten sehen zum Beispiel so aus:

    { "items": [ { "id": "0000000000000000", "tenant": "boilerplate", "sha256CheckSum": "0000000000000000", "subject": { "conference_id": "111111111111111", "meta": { "moderator": { "account_id": "1", "firstname": "Max", "lastname": "Musterman", "email": "max.musterman@flexperto.com" }, "tenant": "boilerplate", "meeting_id": "999", "participants": [], "created_at": "2021-01-01T08:00:00.000Z", "updated_at": "2021-01-01T08:00:00.000Z", "closed_at": "2021-01-01T10:00:00.000Z" } }, "status": "AVAILABLE", "fileId": "22222222222222222222", "createdAt": "2021-01-01T11:00:00.000Z", "updatedAt": "2021-01-01T11:00:00.000Z" }, { "id": "66666666666666", "tenant": "boilerplate", "sha256CheckSum": "0000000000000001", "subject": { "conference_id": "5555555555555", "meta": { "moderator": { "account_id": "1", "firstname": "Moritz", "lastname": "Musterman", "email": "moritz.musterman@flexperto.com" }, "tenant": "boilerplate", "meeting_id": "1000", "participants": [], "created_at": "2021-01-02T08:00:00.000Z", "updated_at": "2021-01-02T08:00:00.000Z", "closed_at": "2021-01-02T10:00:00.000Z" } }, "status": "AVAILABLE", "fileId": "44444444444444", "createdAt": "2021-01-02T11:00:00.000Z", "updatedAt": "2021-01-02T11:00:00.000Z" }, ], "limit": 100, "offset": 0, "total": 2 }


    Zum besseren Verständnis des obigen Beispieles:

    1. Alles zwischen items: [ auf Zeile 2 und ] auf Zeile 55 sind Beschreibungen von Archiven. Ihre Liste an Ergebnissen ist vermutlich länger als im Beispiel.

    2. Die einzelnen Archive sind begrenzt von eingerückten { und }. Konkret sind im obigen Beispiel zwei Archive, zwischen den Zeilen 3 und 28, und zwischen den Zeilen 29 und 54.

    3. Wichtige Datenpunkte innerhalb der Archive sind:

      1. id: Die eindeutige Identifikation des Archives

      2. firstname: Der Vorname des Beraters.

      3. lastname: Der Nachname des Beraters.

      4. email: Die E-Mail-Adresse des Beraters.

      5. closed_at: Das Datum, an dem die Konferenz geschlossen wurde, im ISO-Format.

  5. Wählen Sie sich nun eine beliebige id aus der Liste der Resultate. Durchsuchen Sie hierzu die Archive nach relevanten Datenpunkten. Im Zweifelsfall nutzen Sie die Suchfunktion ihres Browsers (Strg + F / CMD + F), um zum Beispiel die E-Mail eines Beraters zu suchen. Kopieren Sie die ID, ohne Anführungsstriche.

  6. Zuletzt, öffnen Sie einen neuen Browsertab, und fügen folgende Adresse ein:
    https://PLATTFORM/api/v2/communication/archives/archives/ID/download
    Wobei Sie hier PLATTFORM ersetzen durch Ihre Firmenplattform, z.B. mlpfinanzberatung.live.flexperto.com, und ID mit der ID aus dem vorherigen Schritt. Die Adresse für das erste Archiv im obigen Datensatz würde zum Beispiel so aussehen:
    https://boilerplate.test.flexperto.com/api/v2/communication/archives/archives/0000000000000000/download.

  7. Der Aufruf der Seite sollte den Download des Archives starten.