Oversikt over Plecto API Endepunkter

Liste over Plecto API Endepunkter

Plecto lar deg få tilgang til følgende endepunkter ved å bruke enten V2 eller V3 base URL:

Base URL: https://app.plecto.com/api/v2/

V2 Endepunkter, gruppert etter tema:

• /dashboards/

• /datasources/

• /registrations/

• /members/

• /teams/

  • /my-teams/

• /slideshows/

  • /screens/

  • /screen-devices/

  • /devices/

• /favorites/

• /formulas/

Base URL: https://app.plecto.com/api/v3/

V3 Endepunkter:

• /achievement-types/

  • /achievement-type-icons/

• /posts/

Dashboards

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

• Methods: GET, POST

• Description: Hent eller opprett dashboards i Plecto. GET returnerer detaljer om eksisterende dashboards, mens POST oppretter et nytt dashboard.

• Example POST request above

Favoritter

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

• Methods: GET, POST

• Description: Hent dashboards merket som favoritter eller legg til nye favoritter. Favoritt dashboards vises som snarveier på Hjem-siden i Plecto UI.

• Example POST request above

Nyhetsfeed innlegg

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

• Methods: GET

• Description: Les innlegg og send oppdateringer til din Plecto Nyhetsfeed.

• Example POST request above

Enheter

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

• Methods: GET, POST

• Description: Hent eller opprett enheter knyttet til API-brukeren, som en aktivert TV eller mobilapp der brukeren er logget inn.

• Example POST request above

Brukernavnet og passordet er nødvendig for å opprette en token som du vil motta i forespørselens svar.

Team

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

• Methods: GET, POST

• Description: Opprett eller list team innen Plecto. Team brukes til å gruppere medlemmer og knytte dem til dashboards, datakilder og andre funksjoner.

• Example POST request above

Registreringer

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

• Methods: GET, POST, PUT, DELETE

• Description: Hent, oppdater eller slett registreringer knyttet til en datakilde.

• Usage information:

  • Du kan GET, PUT og DELETE en spesifikk registrering på url /api/v2/registrations/<data_source>/<uuid>/

  • Du kan filtrere registrering med følgende spørringsstrengparametere:

    • 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)

  • Du kan kontrollere paginering med "page" parameteren.

• Example POST request to /api/v2/registrations/ above

Mine team

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

• Methods: GET

• Description: List teamene som den autentiserte brukeren er medlem eller leder av. Globale administratorer vil fortsatt se alle team; alle andre brukere vil bare se sine tilknyttede team.

Skjermer

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

• Methods: GET

• Description: Få en liste over lysbildefremvisninger. Detaljene inkluderer lysbildefremvisningens UUID, navn, rotasjon og organisasjons UUID.

Medlemmer

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

• Methods: GET, POST

• Description: Administrer medlemdata i organisasjonen. Medlemmer vil bli listet på Ansatte-siden i Plecto, og hvis de sender data, vil de bli vist i de relevante datakildene.

• Usage information: Bruk GET for å filtrere basert på parametere som api_provider eller api_id, og POST for å legge til nye medlemmer:

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

• Example POST request above

Skjerm enheter

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

• Methods: GET

• Description: Dette endepunktet returnerer en liste over skjermer (TV-er eller dataskjermer) hvor lysbildefremvisningene dine har blitt sendt.

Temaer

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

• Methods: GET, POST

• Description: Hent eller opprett nye temaer som du kan bruke på Plecto dashboards og konkurranser.

• Example POST Request above

Lysbildefremvisninger

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

• Methods: GET, POST

• Description: Bruk dette for å administrere dine Plecto lysbildefremvisninger. Du kan opprette lysbildefremvisninger med forskjellige dashboard, konkurranse, YouTube og URL lysbilder.

• Example POST request above

Prestasjoner

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

• Methods: GET, POST

• Description: Hent eller opprett nye prestasjoner i Plecto. Velg mellom utmerkelser, rekorder, medlemskapsprestasjoner. Les mer om hvordan prestasjoner fungerer her.

• Example POST Request above

Datakilder

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

• Methods: GET, POST

• Description: Få tilgang til eller opprett datakilder, som fungerer som grunnlaget for å administrere data innen Plecto.

• Example POST request above

team vs. my-teams - Hva er forskjellen?

Forskjellen mellom /teams/ og /my-teams/ endepunktene ligger i omfanget og detaljene i dataene de gir:

Omfang av data:

• /teams/ henter alle team innen organisasjonen. Det gir informasjon om hvert team, inkludert deres id, uuid, medlemmer, ledere, organisasjon og tilknyttede datakilder.

• /my-teams/ returnerer kun teamene som er direkte knyttet til den autentiserte brukeren. Dette er vanligvis teamene som brukeren er medlem eller leder av.

Svar detaljer:

• /teams/ gir et mer omfattende sett med data for hvert team, som id, organisasjon, data_sources, home_dashboard, og home_screens. Det bruker numeriske ID-er for medlemmer og ledere.

• /my-teams/ tilbyr en forenklet visning av hvert team, og utelater noen felt som organisasjon, home_dashboard, og data_sources. Svaret inkluderer et picture felt og bruker UUID-er for medlemmer og ledere i stedet for numeriske ID-er.

Bruksområde forskjeller:

• Bruk /teams/ når du trenger en fullstendig liste over alle team i organisasjonen eller trenger detaljert informasjon om teamene.

• Bruk /my-teams/ for raskt å hente teamene som den autentiserte brukeren er tilknyttet, noe som gjør det nyttig for personlige dashboards eller bruker-spesifikke funksjoner.

Formler

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

• Methods: GET, POST

• Description: Hent eller opprett formler. Alle formler er universelle og kan brukes på tvers av alle Plecto-funksjoner.

• Example POST request above

Ikoner for prestasjonstyper

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

• Methods: GET

• Description: Hent ikonene til dine prestasjonsmerker. Du vil få bildelinker i svaret.