Översikt av Plecto API Endpointar

Lista över Plecto API Endpointar

Plecto låter dig få tillgång till följande endpointar med antingen V2 eller V3 bas-URL:

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

V2 Endpointar, grupperade efter tema:

• /dashboards/

• /datasources/

• /registrations/

• /members/

• /teams/

  • /my-teams/

• /slideshows/

  • /screens/

  • /screen-devices/

  • /devices/

• /favorites/

• /formulas/

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

V3 Endpointar:

• /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: Hämta eller skapa dashboards i Plecto. GET returnerar detaljer om befintliga dashboards, medan POST skapar en ny dashboard.

• Example POST request ovan

Datakällor

{
  "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å tillgång till eller skapa datakällor, som fungerar som grunden för att hantera data inom Plecto.

• Example POST request ovan

Registreringar

{

"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: Hämta, uppdatera eller ta bort registreringar kopplade till en datakälla.

• Användarinformation:

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

  • Du kan filtrera registreringar med följande frågesträngparametrar:

    • 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 kontrollera paginering med "page"-parametern.

• Example POST request till /api/v2/registrations/ ovan

Medlemmar

{
   "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: Hantera medlemsdata i organisationen. Medlemmar kommer att listas på sidan Anställda i Plecto, och om data skickas kommer de att visas i de relevanta datakällorna.

• Användarinformation: Använd GET för att filtrera baserat på parametrar som api_provider eller api_id, och POST för att lägga till nya medlemmar:

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

• Example POST request ovan

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: Skapa eller lista team inom Plecto. Team används för att gruppera medlemmar och koppla dem till dashboards, datakällor och andra funktioner.

• Example POST request ovan

Mina team

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

• Methods: GET

• Description: Lista de team som den autentiserade användaren är medlem eller chef för. Globala administratörer kommer fortfarande att se alla team; alla andra användare kommer endast att se sina associerade team.

team vs. my-teams - Vad är skillnaden?

Skillnaden mellan endpointarna /teams/ och /my-teams/ ligger i omfattningen och detaljerna av de data de tillhandahåller:

Omfattning av data:

• /teams/ hämtar alla team inom organisationen. Den tillhandahåller information om varje team, inklusive deras id, uuid, medlemmar, chefer, organisation och associerade datakällor.

• /my-teams/ returnerar endast de team som är direkt kopplade till den autentiserade användaren. Dessa är vanligtvis de team som användaren är medlem eller chef för.

Svarsdetaill:

• /teams/ tillhandahåller en mer omfattande uppsättning data för varje team, såsom id, organization, data_sources, home_dashboard, och home_screens. Den använder numeriska ID:n för medlemmar och chefer.

• /my-teams/ erbjuder en förenklad vy av varje team, och utelämnar vissa fält som organization, home_dashboard, och data_sources. Svaret inkluderar ett picture-fält och använder UUID:er för medlemmar och chefer istället för numeriska ID:n.

Användningsfallsskillnader:

• Använd /teams/ när du behöver en fullständig lista över alla team i organisationen eller behöver detaljerad information om teamen.

• Använd /my-teams/ för att snabbt hämta team som den autentiserade användaren är kopplad till, vilket gör det användbart för personliga dashboards eller användarspecifik funktionalitet.

Bildspel

{
    "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: Använd detta för att hantera dina Plecto bildspel. Du kan skapa bildspel med olika dashboards, tävlingar, YouTube- och URL-bilder.

• Example POST request ovan

Skärmar

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

• Methods: GET

• Description: Få en lista över bildspel. Detaljerna inkluderar bildspels UUID, namn, rotation och organisations UUID.

Skärmenheter

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

• Methods: GET

• Description: Denna endpoint returnerar en lista över skärmar (TV-apparater eller datorskärmar) där dina bildspel har skickats.

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: Hämta eller skapa enheter kopplade till API-användaren, såsom en aktiverad TV eller mobilapp där användaren är inloggad.

• Example POST request ovan

Användarnamn och lösenord behövs för att skapa en token som du kommer att få i begärans svar.

Favoriter

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

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

• Methods: GET, POST

• Description: Hämta dashboards som markerats som favoriter eller lägg till nya favoriter. Favoritdashboards visas som genvägar på startsidan i Plecto UI.

• Example POST request ovan

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: Hämta eller skapa formler. Alla formler är universella och kan användas över alla Plecto-funktioner.

• Example POST request ovan

Prestationer

{
   "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: Hämta eller skapa nya prestationer i Plecto. Välj mellan utmärkelser, rekord, medlemskaps prestationer. Läs mer om hur prestationer fungerar här.

• Example POST Request ovan

Ikoner för prestationstyper

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

• Methods: GET

• Description: Hämta ikonerna för dina prestationsmärken. Du får bildlänkarna i svaret.

Nyhetsflödesinlägg

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

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

• Methods: GET

• Description: Läs inlägg och skicka uppdateringar till ditt Plecto Nyhetsflöde.

• Example POST request ovan

Teman

{
   "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: Hämta eller skapa nya teman som du kan använda på Plecto dashboards och tävlingar.

• Example POST Request ovan