Overzicht van Plecto API Eindpunten

Lijst van Plecto API Eindpunten

Plecto stelt je in staat om toegang te krijgen tot de volgende eindpunten met behulp van de V2 of V3 basis-URL:

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

V2 Eindpunten, gegroepeerd op thema:

• /dashboards/

• /datasources/

• /registrations/

• /members/

• /teams/

  • /my-teams/

• /slideshows/

  • /screens/

  • /screen-devices/

  • /devices/

• /favorites/

• /formulas/

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

V3 Eindpunten:

• /achievement-types/

  • /achievement-type-icons/

• /posts/

Dashboards

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

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

• Methoden: GET, POST

• Beschrijving: Haal dashboards op of maak ze aan in Plecto. GET retourneert details over bestaande dashboards, terwijl POST een nieuw dashboard aanmaakt.

• Voorbeeld POST-verzoek hierboven

Gegevensbronnen

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

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

• Methoden: GET, POST

• Beschrijving: Toegang tot of maak gegevensbronnen aan, die de basis vormen voor het beheren van gegevens binnen Plecto.

• Voorbeeld POST-verzoek hierboven

Registraties

{

"data_source": "12a121212044412faf1b4801b0eb20e8",

"member": "e1c222ebbc1812be1cbb1c101ced4523",

"external_id": "0p23oi5",

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

"Product Name": "Green tea",

"Units Sold": 2

}

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

• Methoden: GET, POST, PUT, DELETE

• Beschrijving: Haal registraties op, werk ze bij of verwijder registraties die aan een gegevensbron zijn gekoppeld.

• Gebruik informatie:

  • Je kunt een specifieke registratie GET, PUT en DELETE op de url /api/v2/registrations/<data_source>/<uuid>/

  • Je kunt registraties filteren met de volgende querystringparameters:

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

  • Je kunt paginering controleren met de "page" parameter.

• Voorbeeld POST-verzoek naar /api/v2/registrations/ hierboven

Leden

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

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

• Methoden: GET, POST

• Beschrijving: Beheer ledengegevens in de organisatie. Leden worden vermeld op de pagina Werknemers in Plecto, en als gegevens worden verzonden, worden ze weergegeven in de relevante gegevensbronnen.

• Gebruik informatie: Gebruik GET om te filteren op basis van parameters zoals api_provider of api_id, en POST om nieuwe leden toe te voegen:

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

• Voorbeeld POST-verzoek hierboven

Teams

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

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

• Methoden: GET, POST

• Beschrijving: Maak teams aan of lijst teams binnen Plecto. Teams worden gebruikt om leden te groeperen en ze te associëren met dashboards, gegevensbronnen en andere functies.

• Voorbeeld POST-verzoek hierboven

Mijn teams

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

• Methoden: GET

• Beschrijving: Lijst de teams waarvan de geauthenticeerde gebruiker lid of manager is. Global Admins zien nog steeds alle teams; alle andere gebruikers zien alleen hun bijbehorende teams.

teams vs. my-teams - Wat is het verschil?

Het verschil tussen de /teams/ en /my-teams/ eindpunten ligt in de reikwijdte en details van de gegevens die ze bieden:

Reikwijdte van gegevens:

• /teams/ haalt alle teams binnen de organisatie op. Het biedt informatie over elk team, inclusief hun id, uuid, leden, managers, organisatie en bijbehorende gegevensbronnen.

• /my-teams/ retourneert alleen de teams die direct zijn gekoppeld aan de geauthenticeerde gebruiker. Dit zijn doorgaans de teams waarvan de gebruiker lid of manager is.

Responsdetails:

• /teams/ biedt een meer uitgebreide set gegevens voor elk team, zoals id, organisatie, data_sources, home_dashboard, en home_screens. Het gebruikt numerieke ID's voor leden en managers.

• /my-teams/ biedt een vereenvoudigd overzicht van elk team, waarbij sommige velden zoals organisatie, home_dashboard, en data_sources worden weggelaten. De respons bevat een picture veld en gebruikt UUID's voor leden en managers in plaats van numerieke ID's.

Verschillen in gebruiksgevallen:

• Gebruik /teams/ wanneer je een volledige lijst van alle teams in de organisatie nodig hebt of gedetailleerde informatie over de teams vereist.

• Gebruik /my-teams/ om snel teams op te halen waarmee de geauthenticeerde gebruiker is geassocieerd, wat nuttig is voor gepersonaliseerde dashboards of gebruikersspecifieke functionaliteit.

Dia's

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

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

• Methoden: GET, POST

• Beschrijving: Gebruik dit om je Plecto dia's te beheren. Je kunt dia's maken met verschillende dashboards, wedstrijden, YouTube en URL-dia's.

• Voorbeeld POST-verzoek hierboven

Schermen

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

• Methoden: GET

• Beschrijving: Krijg een lijst van dia's. De details omvatten de dia UUID, naam, rotatie en organisatie UUID.

Scherm apparaten

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

• Methoden: GET

• Beschrijving: Dit eindpunt retourneert een lijst van schermen (tv's of computerschermen) waar je dia's naartoe zijn gestuurd.

Apparaten

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

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

• Methoden: GET, POST

• Beschrijving: Haal apparaten op of maak apparaten aan die aan de API-gebruiker zijn gekoppeld, zoals een geactiveerde tv of mobiele app waar de gebruiker is ingelogd.

• Voorbeeld POST-verzoek hierboven

De gebruikersnaam en het wachtwoord zijn nodig om een token te creëren dat je in de verzoekrespons zult ontvangen.

Favorieten

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

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

• Methoden: GET, POST

• Beschrijving: Haal dashboards op die als favoriet zijn gemarkeerd of voeg nieuwe favorieten toe. Favoriete dashboards verschijnen als snelkoppelingen op de startpagina in de Plecto UI.

• Voorbeeld POST-verzoek hierboven

Formules

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

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

• Methoden: GET, POST

• Beschrijving: Haal formules op of maak ze aan. Alle formules zijn universeel en kunnen worden gebruikt in alle Plecto-functies.

• Voorbeeld POST-verzoek hierboven

Prestaties

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

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

• Methoden: GET, POST

• Beschrijving: Haal nieuwe prestaties op of maak ze aan in Plecto. Kies tussen award, record, lidmaatschapsprestaties. Lees meer over hoe prestaties werken hier.

• Voorbeeld POST-verzoek hierboven

Prestatietype-iconen

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

• Methoden: GET

• Beschrijving: Haal de iconen van je prestatiebadges op. Je ontvangt de afbeeldingslinks in de responsbody.

Nieuwsfeed berichten

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

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

• Methoden: GET

• Beschrijving: Lees berichten en stuur updates naar je Plecto Nieuwsfeed.

• Voorbeeld POST-verzoek hierboven

Thema's

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

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

• Methoden: GET, POST

• Beschrijving: Haal nieuwe thema's op of maak ze aan die je kunt gebruiken op Plecto dashboards en wedstrijden.

• Voorbeeld POST-verzoek hierboven