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

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

• 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

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/

• Metoder: GET, POST

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

• Eksempel på POST-request ovenfor

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/

• Metoder: GET, POST, PUT, DELETE

• Beskrivelse: Hent, opdater eller slet registreringer tilknyttet en datakilde.

• Brugsinformation:

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

  • Du kan filtrere registreringer med følgende query string-parametre:

    • 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 styre paginering med parameteren "page".

• Eksempel på POST-request til /api/v2/registrations/ ovenfor

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/

• 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

Teams

{
    '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/

• 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

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.

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.

Slideshows

{
    "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/

• 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

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.

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.

Enheder

{
   "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/

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

Favoritter

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

• 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

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/

• 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

Achievements

{
   "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/

• 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

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.

Nyhedsfeed-opslag

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

• 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

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/

• Metoder: GET, POST

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

• Eksempel på POST-request ovenfor