Centre d'aide

Connexion

Plecto

Aperçu des points de terminaison de l'API Plecto

Liste des points de terminaison de l'API Plecto

Plecto vous permet d'accéder aux points de terminaison suivants en utilisant soit l'URL de base V2, soit l'URL de base V3 :

URL de base : https://app.plecto.com/api/v2/

Points de terminaison V2, regroupés par thème :

  • /dashboards/

  • /datasources/

  • /registrations/

  • /members/

  • /teams/

    • /my-teams/

  • /slideshows/

    • /screens/

    • /screen-devices/

    • /devices/

  • /favorites/

  • /formulas/

URL de base : https://app.plecto.com/api/v3/

Points de terminaison V3 :

  • /achievement-types/

    • /achievement-type-icons/

  • /posts/

Dashboards

  • Point de terminaison : https://app.plecto.com/api/v2/dashboards/

  • Méthodes : GET, POST

  • Description : Récupérer ou créer des dashboards dans Plecto. GET renvoie des détails sur les dashboards existants, tandis que POST crée un nouveau dashboard.

  • Exemple de requête POST ci-dessus

Favoris

  • Point de terminaison : https://app.plecto.com/api/v2/favorites/

  • Méthodes : GET, POST

  • Description : Récupérer les dashboards marqués comme favoris ou ajouter de nouveaux favoris. Les dashboards favoris apparaissent comme des raccourcis sur la page d'accueil de l'interface Plecto.

  • Exemple de requête POST ci-dessus

Publications du fil d'actualités

  • Point de terminaison : https://app.plecto.com/api/v3/posts/

  • Méthodes : GET

  • Description : Lire les publications et envoyer des mises à jour à votre fil d'actualités Plecto.

  • Exemple de requête POST ci-dessus

Appareils

  • Point de terminaison : https://app.plecto.com/api/v2/devices/

  • Méthodes : GET, POST

  • Description : Récupérer ou créer des appareils liés à l'utilisateur de l'API, tels qu'une télévision activée ou une application mobile où l'utilisateur est connecté.

  • Exemple de requête POST ci-dessus

Le nom d'utilisateur et le mot de passe sont nécessaires pour créer un jeton que vous recevrez dans la réponse de la requête.

Équipes

  • Point de terminaison : https://app.plecto.com/api/v2/teams/

  • Méthodes : GET, POST

  • Description : Créer ou lister des équipes au sein de Plecto. Les équipes sont utilisées pour regrouper les membres et les associer à des dashboards, des sources de données et d'autres fonctionnalités.

  • Exemple de requête POST ci-dessus

Inscriptions

Mes équipes

  • Point de terminaison : https://app.plecto.com/api/v2/my-teams/

  • Méthodes : GET

  • Description : Lister les équipes dont l'utilisateur authentifié est membre ou manager. Les administrateurs globaux verront toujours toutes les équipes ; tous les autres utilisateurs ne verront que leurs équipes associées.

Écrans

  • Point de terminaison : https://app.plecto.com/api/v2/screens/

  • Méthodes : GET

  • Description : Obtenir une liste de diaporamas. Les détails incluent l'UUID du diaporama, le nom, la rotation et l'UUID de l'organisation.

Membres

  • Point de terminaison : https://app.plecto.com/api/v2/members/

  • Méthodes : GET, POST

  • Description : Gérer les données des membres dans l'organisation. Les membres seront listés sur la page des employés dans Plecto, et s'ils envoient des données, ils seront affichés dans les sources de données pertinentes.

  • Informations d'utilisation : Utilisez GET pour filtrer en fonction de paramètres tels que api_provider ou api_id, et POST pour ajouter de nouveaux membres :

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

  • Exemple de requête POST ci-dessus

Appareils d'écran

  • Point de terminaison : https://app.plecto.com/api/v2/screen-devices/

  • Méthodes : GET

  • Description : Ce point de terminaison renvoie une liste d'écrans (télévisions ou écrans d'ordinateur) où vos diaporamas ont été envoyés.

Thèmes

  • Point de terminaison : https://app.plecto.com/api/v2/themes/

  • Méthodes : GET, POST

  • Description : Récupérer ou créer de nouveaux thèmes que vous pouvez utiliser sur les dashboards et concours Plecto.

  • Exemple de requête POST ci-dessus

Diaporamas

  • Point de terminaison : https://app.plecto.com/api/v2/slideshows/

  • Méthodes : GET, POST

  • Description : Utilisez ceci pour gérer vos diaporamas Plecto. Vous pouvez créer des diaporamas avec divers dashboards, concours, YouTube et diapositives d'URL.

  • Exemple de requête POST ci-dessus

Réalisations

  • Point de terminaison : https://app.plecto.com/api/v3/achievement-types/

  • Méthodes : GET, POST

  • Description : Récupérer ou créer de nouvelles réalisations dans Plecto. Choisissez entre des réalisations de récompense, de record ou d'adhésion. Lisez-en plus sur le fonctionnement des réalisations ici.

  • Exemple de requête POST ci-dessus

Sources de données

  • Point de terminaison : https://app.plecto.com/api/v2/datasources/

  • Méthodes : GET, POST

  • Description : Accéder ou créer des sources de données, qui servent de fondation pour gérer les données au sein de Plecto.

  • Exemple de requête POST ci-dessus

équipes vs. mes équipes - Quelle est la différence ?

La différence entre les points de terminaison /teams/ et /my-teams/ réside dans la portée et les détails des données qu'ils fournissent :

Portée des données :

  • /teams/ récupère toutes les équipes au sein de l'organisation. Il fournit des informations sur chaque équipe, y compris leur id, uuid, membres, managers, organisation et sources de données associées.

  • /my-teams/ renvoie uniquement les équipes qui sont directement associées à l'utilisateur authentifié. Ce sont généralement les équipes dont l'utilisateur est membre ou manager.

Détails de la réponse :

  • /teams/ fournit un ensemble de données plus complet pour chaque équipe, tel que id, organization, data_sources, home_dashboard, et home_screens. Il utilise des ID numériques pour les membres et les managers.

  • /my-teams/ offre une vue simplifiée de chaque équipe, omettant certains champs comme organization, home_dashboard, et data_sources. La réponse inclut un champ picture et utilise des UUID pour les membres et les managers au lieu d'ID numériques.

Différences d'utilisation :

  • Utilisez /teams/ lorsque vous avez besoin d'une liste complète de toutes les équipes de l'organisation ou si vous avez besoin d'informations détaillées sur les équipes.

  • Utilisez /my-teams/ pour récupérer rapidement les équipes auxquelles l'utilisateur authentifié est associé, ce qui est utile pour des dashboards personnalisés ou des fonctionnalités spécifiques à l'utilisateur.

Formules

  • Point de terminaison : https://app.plecto.com/api/v2/formulas/

  • Méthodes : GET, POST

  • Description : Récupérer ou créer des formules. Toutes les formules sont universelles et peuvent être utilisées dans toutes les fonctionnalités de Plecto.

  • Exemple de requête POST ci-dessus

Icônes de type de réalisation

  • Point de terminaison : https://app.plecto.com/api/v3/achievement-type-icons/

  • Méthodes : GET

  • Description : Récupérer les icônes de vos badges de réalisation. Vous recevrez les liens d'image dans le corps de la réponse.