Übersicht über Plecto-API-Endpunkte

Liste der Plecto-API-Endpunkte

Plecto ermöglicht Ihnen den Zugriff auf die folgenden Endpunkte, entweder über die V2- oder die V3-Basis-URL:

Basis-URL: https://app.plecto.com/api/v2/

V2-Endpunkte, gruppiert nach Thema:

• /dashboards/

• /datasources/

• /registrations/

• /members/

• /teams/

  • /my-teams/

• /slideshows/

  • /screens/

  • /screen-devices/

  • /devices/

• /favorites/

• /formulas/

Basis-URL: https://app.plecto.com/api/v3/

V3-Endpunkte:

• /achievement-types/

  • /achievement-type-icons/

• /posts/

Dashboards

• Endpunkt: https://app.plecto.com/api/v2/dashboards/

• Methoden: GET, POST

• Beschreibung: Abrufen oder Erstellen von Dashboards in Plecto. GET liefert Details zu bestehenden Dashboards, während POST ein neues Dashboard erstellt.

• Beispiel-POST-Anfrage oben

Favoriten

• Endpunkt: https://app.plecto.com/api/v2/favorites/

• Methoden: GET, POST

• Beschreibung: Abrufen von als Favorit markierten Dashboards oder Hinzufügen neuer Favoriten. Favorisierte Dashboards erscheinen als Verknüpfungen auf der Startseite der Plecto-Benutzeroberfläche.

• Beispiel-POST-Anfrage oben

News-Feed-Beiträge

• Endpunkt: https://app.plecto.com/api/v3/posts/

• Methoden: GET

• Beschreibung: Beiträge lesen und Updates an Ihren Plecto-News-Feed senden.

• Beispiel-POST-Anfrage oben

Geräte

• Endpunkt: https://app.plecto.com/api/v2/devices/

• Methoden: GET, POST

• Beschreibung: Abrufen oder Erstellen von Geräten, die mit dem API-Benutzer verknüpft sind, wie z. B. einem aktivierten Fernseher oder einer mobilen App, bei der der Benutzer angemeldet ist.

• Beispiel-POST-Anfrage oben

Der Benutzername und das Passwort werden benötigt, um ein Token zu erstellen, das Sie in der Antwort auf die Anfrage erhalten.

Teams

• Endpunkt: https://app.plecto.com/api/v2/teams/

• Methoden: GET, POST

• Beschreibung: Erstellen oder Auflisten von Teams innerhalb von Plecto. Teams werden verwendet, um Mitglieder zu gruppieren und sie mit Dashboards, Datenquellen und anderen Funktionen zu verknüpfen.

• Beispiel-POST-Anfrage oben

Registrierungen

• Endpunkt: https://app.plecto.com/api/v2/registrations/

• Methoden: GET, POST, PUT, DELETE

• Beschreibung: Abrufen, Aktualisieren oder Löschen von Registrierungen, die mit einer Datenquelle verknüpft sind.

• Nutzungsinformationen:

  • Sie können eine bestimmte Registrierung unter der URL /api/v2/registrations/<data_source>/<uuid>/ per GET, PUT und DELETE ansprechen

  • Sie können Registrierungen mit den folgenden Query-String-Parametern filtern:

    • start_date (https://app.plecto.com/api/v2/registrations/?start\_date=2024-06-01T22:22:00)

    • end_date (https://app.plecto.com/api/v2/registrations/?end\_date=2024-06-01T22:22:00)

    • reference/external_id (https://app.plecto.com/api/v2/registrations/?reference=123)

    • data_source (https://app.plecto.com/api/v2/registrations/?data\_source=412c64d13fbf4c89bacd4224fb16a6db)

  • Sie können die Paginierung mit dem Parameter „page“ steuern.

• Beispiel-POST-Anfrage an /api/v2/registrations/ oben

Meine Teams

• Endpunkt: https://app.plecto.com/api/v2/my-teams/

• Methoden: GET

• Beschreibung: Listet die Teams auf, in denen der authentifizierte Benutzer Mitglied oder Manager ist. Globale Administratoren sehen weiterhin alle Teams; alle anderen Benutzer sehen nur ihre zugehörigen Teams.

Screens

• Endpunkt: https://app.plecto.com/api/v2/screens/

• Methoden: GET

• Beschreibung: Ruft eine Liste von Diashows ab. Die Details umfassen die UUID der Diashow, den Namen, die Rotation und die UUID der Organisation.

Mitglieder

• Endpunkt: https://app.plecto.com/api/v2/members/

• Methoden: GET, POST

• Beschreibung: Verwaltung der Mitgliederdaten in der Organisation. Mitglieder werden auf der Seite „Mitarbeiter“ in Plecto aufgeführt und, sofern sie Daten senden, in den entsprechenden Datenquellen angezeigt.

• Nutzungsinformationen: Verwenden Sie GET, um basierend auf Parametern wie api_provider oder api_id zu filtern, und POST, um neue Mitglieder hinzuzufügen:

  • GET /api/v2/members/?api_provider=<Ihr api_provider>&api_id=<Ihre ID>

• Beispiel-POST-Anfrage oben

Screen-Geräte

• Endpunkt: https://app.plecto.com/api/v2/screen-devices/

• Methoden: GET

• Beschreibung: Dieser Endpunkt gibt eine Liste von Bildschirmen (Fernseher oder Computerbildschirme) zurück, an die Ihre Diashows gesendet wurden.

Themes

• Endpunkt: https://app.plecto.com/api/v2/themes/

• Methoden: GET, POST

• Beschreibung: Abrufen oder Erstellen neuer Themes, die Sie auf Plecto-Dashboards und -Wettbewerben verwenden können.

• Beispiel-POST-Anfrage oben

Diashows

• Endpunkt: https://app.plecto.com/api/v2/slideshows/

• Methoden: GET, POST

• Beschreibung: Verwenden Sie dies, um Ihre Plecto-Diashows zu verwalten. Sie können Diashows mit verschiedenen Dashboard-, Wettbewerbs-, YouTube- und URL-Folien erstellen.

• Beispiel-POST-Anfrage oben

Achievements

• Endpunkt: https://app.plecto.com/api/v3/achievement-types/

• Methoden: GET, POST

• Beschreibung: Abrufen oder Erstellen neuer Achievements in Plecto. Wählen Sie zwischen Award-, Rekord- und Mitgliedschafts-Achievements. Erfahren Sie hier mehr darüber, wie Achievements funktionieren.

• Beispiel-POST-Anfrage oben

Datenquellen

• Endpunkt: https://app.plecto.com/api/v2/datasources/

• Methoden: GET, POST

• Beschreibung: Zugriff auf oder Erstellung von Datenquellen, die als Grundlage für die Datenverwaltung in Plecto dienen.

• Beispiel-POST-Anfrage oben

teams vs. my-teams - Was ist der Unterschied?

Der Unterschied zwischen den Endpunkten /teams/ und /my-teams/ liegt im Umfang und den Details der bereitgestellten Daten:

Datenumfang:

• /teams/ ruft alle Teams innerhalb der Organisation ab. Es liefert Informationen zu jedem Team, einschließlich id, uuid, Mitgliedern, Managern, Organisation und zugehörigen Datenquellen.

• /my-teams/ gibt nur die Teams zurück, die direkt mit dem authentifizierten Benutzer verknüpft sind. Dies sind in der Regel die Teams, in denen der Benutzer Mitglied oder Manager ist.

Details der Antwort:

• /teams/ liefert einen umfassenderen Datensatz für jedes Team, wie id, organization, data_sources, home_dashboard und home_screens. Es verwendet numerische IDs für Mitglieder und Manager.

• /my-teams/ bietet eine vereinfachte Ansicht jedes Teams und lässt einige Felder wie organization, home_dashboard und data_sources aus. Die Antwort enthält ein picture-Feld und verwendet UUIDs für Mitglieder und Manager anstelle numerischer IDs.

Unterschiede im Anwendungsfall:

• Verwenden Sie /teams/, wenn Sie eine vollständige Liste aller Teams in der Organisation benötigen oder detaillierte Informationen zu den Teams erfordern.

• Verwenden Sie /my-teams/, um schnell die Teams abzurufen, denen der authentifizierte Benutzer zugeordnet ist, was für personalisierte Dashboards oder benutzerspezifische Funktionen nützlich ist.

Formeln

• Endpunkt: https://app.plecto.com/api/v2/formulas/

• Methoden: GET, POST

• Beschreibung: Abrufen oder Erstellen von Formeln. Alle Formeln sind universell einsetzbar und können in allen Plecto-Funktionen verwendet werden.

• Beispiel-POST-Anfrage oben

Achievement-Typ-Icons

• Endpunkt: https://app.plecto.com/api/v3/achievement-type-icons/

• Methoden: GET

• Beschreibung: Abrufen der Icons Ihrer Achievement-Abzeichen. Sie erhalten die Bild-Links im Antwort-Body.