Hjælpecenter

Log ind

Plecto

Oversigt over Plecto API Endpoints

Liste over Plecto API-endpoints

Plecto giver dig adgang til følgende endpoints ved hjælp af enten V2- eller V3-basis-URL'en:

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

V2-endpoints, grupperet efter tema:

  • /dashboards/

  • /datasources/

  • /registrations/

  • /members/

  • /teams/

    • /my-teams/

  • /slideshows/

    • /screens/

    • /screen-devices/

    • /devices/

  • /favorites/

  • /formulas/

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

V3-endpoints:

  • /achievement-types/

    • /achievement-type-icons/

  • /posts/

Dashboards

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

  • Metoder: GET, POST

  • Beskrivelse: Hent eller opret dashboards i Plecto. GET returnerer detaljer om eksisterende dashboards, mens POST opretter et nyt dashboard.

  • Eksempel på POST-request ovenfor

Favoritter

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

  • Metoder: GET, POST

  • Beskrivelse: Hent dashboards markeret som favorit, eller tilføj nye favoritter. Favorit-dashboards vises som genveje på forsiden i Plecto UI.

  • Eksempel på POST-request ovenfor

Nyhedsfeed-opslag

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

  • Metoder: GET

  • Beskrivelse: Læs opslag, og send opdateringer til dit Plecto-nyhedsfeed.

  • Eksempel på POST-request ovenfor

Enheder

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

  • Metoder: GET, POST

  • Beskrivelse: Hent eller opret enheder tilknyttet API-brugeren, f.eks. et aktiveret TV eller en mobilapp, hvor brugeren er logget ind.

  • Eksempel på POST-request ovenfor

Brugernavnet og adgangskoden er nødvendige for at oprette en token, som du modtager i request-svaret.

Teams

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

  • Metoder: GET, POST

  • Beskrivelse: Opret eller vis en liste over teams i Plecto. Teams bruges til at gruppere medlemmer og knytte dem til dashboards, datakilder og andre funktioner.

  • Eksempel på POST-request ovenfor

Registreringer

Mine teams

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

  • Metoder: GET

  • Beskrivelse: Lister de teams, som den autentificerede bruger er medlem af eller leder for. Globale administratorer vil stadig se alle teams; alle andre brugere ser kun deres tilknyttede teams.

Skærme

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

  • Metoder: GET

  • Beskrivelse: Hent en liste over slideshows. Detaljerne inkluderer slideshowets UUID, navn, rotation og organisationens UUID.

Medlemmer

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

  • Metoder: GET, POST

  • Beskrivelse: Administrer medlemsdata i organisationen. Medlemmer vises på siden Medarbejdere i Plecto, og hvis de sender data, vises de i de relevante datakilder.

  • Brugsinformation: Brug GET til at filtrere baseret på parametre som api_provider eller api_id, og POST til at tilføje nye medlemmer:

    • GET /api/v2/members/?api_provider=<din api_provider>&api_id=<dit id>

  • Eksempel på POST-request ovenfor

Skærmenheder

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

  • Metoder: GET

  • Beskrivelse: Dette endpoint returnerer en liste over skærme (TV'er eller computerskærme), hvor dine slideshows er blevet sendt til.

Temaer

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

  • Metoder: GET, POST

  • Beskrivelse: Hent eller opret nye temaer, som du kan bruge på Plecto-dashboards og konkurrencer.

  • Eksempel på POST-request ovenfor

Slideshows

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

  • Metoder: GET, POST

  • Beskrivelse: Brug dette til at administrere dine Plecto-slideshows. Du kan oprette slideshows med forskellige dashboard-, konkurrence-, YouTube- og URL-slides.

  • Eksempel på POST-request ovenfor

Achievements

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

  • Metoder: GET, POST

  • Beskrivelse: Hent eller opret nye achievements i Plecto. Vælg mellem award-, record- og membership-achievements. Læs mere om, hvordan achievements fungerer, her.

  • Eksempel på POST-request ovenfor

Datakilder

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

  • Metoder: GET, POST

  • Beskrivelse: Tilgå eller opret datakilder, som fungerer som grundlaget for at administrere data i Plecto.

  • Eksempel på POST-request ovenfor

teams vs. my-teams - Hvad er forskellen?

Forskellen mellem endpointene /teams/ og /my-teams/ ligger i omfanget og detaljerne af de data, de leverer:

Datas omfang:

  • /teams/ henter alle teams i organisationen. Det giver information om hvert team, herunder deres id, uuid, medlemmer, ledere, organisation og tilknyttede datakilder.

  • /my-teams/ returnerer kun de teams, der er direkte tilknyttet den autentificerede bruger. Dette er typisk de teams, som brugeren er medlem af eller leder for.

Detaljer i svaret:

  • /teams/ giver et mere omfattende sæt data for hvert team, såsom id, organization, data_sources, home_dashboard og home_screens. Det bruger numeriske ID'er til medlemmer og ledere.

  • /my-teams/ tilbyder en forenklet visning af hvert team og udelader nogle felter som organization, home_dashboard og data_sources. Svaret inkluderer et picture-felt og bruger UUID'er til medlemmer og ledere i stedet for numeriske ID'er.

Forskelle i anvendelse:

  • Brug /teams/ når du har brug for en fuld liste over alle teams i organisationen, eller når du har brug for detaljeret information om teamsene.

  • Brug /my-teams/ for hurtigt at hente de teams, som den autentificerede bruger er tilknyttet, hvilket er nyttigt til personaliserede dashboards eller brugerspecifik funktionalitet.

Formler

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

  • Metoder: GET, POST

  • Beskrivelse: Hent eller opret formler. Alle formler er universelle og kan bruges på tværs af alle Plecto-funktioner.

  • Eksempel på POST-request ovenfor

Achievement-type-ikoner

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

  • Metoder: GET

  • Beskrivelse: Hent ikonerne for dine achievement-badges. Du får billedlinkene i svarets body.