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

{
  "parent": null,
  "level": 0,
  "title": "API Dashboard",
  "organization": "organization_uuid",
  "theme_id": "dark_blue"
}

  • 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

Datakilder

{
  "title": "New API Data Source",
  "fields": [
    {
      "name": "Units Sold",
      "input": "DecimalInput",
      "default_value": ""
    },
    {
      "name": "Product Name",
      "input": "TextInput",
      "default_value": "Coffee"
    }
  ]
}

  • 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

Registreringer

{

"data_source": "12a121212044412faf1b4801b0eb20e8",

"member": "e1c222ebbc1812be1cbb1c101ced4523",

"external_id": "0p23oi5",

"date": "2024-10-10T10:22:55",

"Product Name": "Green tea",

"Units Sold": 2

}

  • 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

Medlemmer

{
   "updating_api_provider_id": "Postman_ID",
   "updating_api_provider": "Postman",
   "updating_api_provider_email": "jane.doe@example.com",
   "name": "Jane Doe",
   "is_active": true,
   "teams": 000000
}

  • 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

Team

{
    'name': 'api-team',
    'organization': org_id,
    'data_sources': [id1, id2],
    'members': [member1_id, member2_id, member3_id],
    'managers': [member1_id, member2_id],
}

  • 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

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.

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.

Lysbildefremvisninger

{
    "name": "My New Slideshow",
    "dashboards": [],
    "rotation": "",
    "slides": [
    {
    "url": "https://www.youtube.com/watch?v=-UPdU4npGm0",
    "dashboard": null,
    "contest_dashboard": null,
    "duration": null,
    "time_from": "00:00:00",
    "time_to": "23:59:59",
    "dynamic_context": null,
    "ordering": 0
    }
    ,
    {
    "url": null,
    "dashboard": 179312,
    "contest_dashboard": null,
    "duration": null,
    "time_from": "00:10:00",
    "time_to": "18:59:59",
    "dynamic_context": null,
    "ordering": 0
    }
    ],
    "slide_duration": 60
}

  • 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

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.

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.

Enheter

{
   "device_name": "New Device",
   "device_type": "tv",
   "device_id": "tv_id",
   "username": "user@example.com",
   "password": "userpassword"
}

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

Favoritter

{
    "dashboard": 180529,
    "order": 0
}

  • 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

Formler

{
   "title": "Total Number of Adversus Appointments",
   "format": "(Count(Adversus Appointments))",
   "prefix": "",
   "suffix": "",
   "output": "DecimalOutput",
   "decimals": 0,
   "lower_value_is_better": false,
   "conditional_colors": [
        {"value": "20", "color": "red"},
        {"value": "70", "color": "yellow"},
        {"value": "100", "color": "green"}
   ],
   "owner": null
}

  • 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

Prestasjoner

{
   "name": "API Achievement",
   "category": "membership",
   "description": "This is an achievement description sent via API",
   "icon": "diamond",
   "custom_icon": null,
   "icon_id": "diamond",
   "shape": "hexagon",
   "color": "silver",
   "time_period": "",
   "show_next_to_name": true
}

  • 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

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.

Nyhetsfeed innlegg

{
    "content": "Today is Tuesday, which means it's cake day!",
    "organization_scope": true
}

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

  • Methods: GET

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

  • Example POST request above

Temaer

{
   "name": "My New Theme",
   "text_color": "#5d5d5d",
   "background_color": "#f9f9f9",
   "background_image": null,
   "background_image_thumbnail": null,
   "background_position": "cover",
   "widget_green_color": "",
   "widget_green_background_color": null,
   "widget_green_background_text_color": null,
   "widget_yellow_color": "",
   "widget_yellow_background_color": null,
   "widget_yellow_background_text_color": null,
   "widget_red_color": "",
   "widget_red_background_color": null,
   "widget_red_background_text_color": null,
   "widget_background_color": "#f9f9f9",
   "widget_border_color": "#f1f1f1",
   "widget_border_radius": "15px",
   "widget_chart_color": "",
   "widget_chart_colors": null,
   "widget_chart_gradients": true,
   "widget_table_achievement_color": "",
   "is_custom": true
}

  • 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