Sur cette page

Développer avec Ideanote

Nous vous remercions de l’intérêt que vous portez au développement avec Ideanote !

Ideanote est conçu de manière modulaire et flexible dès le départ afin de prendre en charge un large éventail de cas d’usage liés à l’innovation. Notre API REST, facile à intégrer, API vous permet de créer des processus d’innovation personnalisés pour votre entreprise, de la collecte d’idées à la gestion des équipes et à la synchronisation des données.

Présentation

Ideanote API repose sur REST. Notre API comporte des URL prévisibles orientées ressources, renvoie des réponses encodées en JSON et utilise les codes de réponse, les méthodes d’authentification et les verbes HTTP standard. Le API est sans état : toutes les requêtes sont validées à l’aide d’un jeton API.

L’API est versionnée afin de garantir la rétrocompatibilité : la version actuelle est v1.

L’URL de base actuelle de l’API est https://api.ideanote.io/v1/.

Veuillez noter que le champ de paramètre de requête URL est obligatoire pour tous les points de terminaison.

Cas d’utilisation

Ideanote API offre un ensemble d’outils puissants permettant d’intégrer des fonctionnalités de gestion des idées à vos processus métier et à votre infrastructure existante.

Parmi les utilisations courantes de notre API, citons l’intégration approfondie de Ideanote dans une application que vous développez vous-même, ainsi que des cas d’usage plus simples, comme l’envoi d’idées à Ideanote ou la synchronisation des données entre Ideanote et une autre application.

Découvrez les exemples suivants :

  • Soumission d’idées : Capturez automatiquement les idées issues des outils de communication internes et des réunions virtuelles via Ideanote API, puis soumettez-les directement à Ideanote pour évaluation.
  • Intégration de la gestion de projets : Transformez facilement les idées approuvées en projets concrets avec Ideanote API, en créant des tâches ou des projets dans des outils de gestion de projets tels que Jira.
  • Commentaires intégrés à l’application : Transmettez directement les commentaires des clients issus de vos applications à Ideanote à l’aide de API, pour favoriser une innovation structurée axée sur les clients.
  • Intelligence d’affaires : Extrayez les données de soumission d’idées à des fins d’analyse décisionnelle et créez des rapports détaillés sur les ROI en matière d’innovation, les meilleures idées et les contributions des employés avec Ideanote API.
  • Reconnaissance des employés : Connectez Ideanote aux systèmes RH afin de récompenser automatiquement les employés pour leur contribution aux idées fructueuses et de renforcer leur engagement.
  • Conformité en matière de confidentialité des données : Assurez votre conformité en utilisant API pour gérer les données des utilisateurs, notamment pour rechercher, mettre à jour ou supprimer les utilisateurs désactivés de votre registre central.

En tirant parti de Ideanote API de cette manière, vous pouvez créer pour votre entreprise un écosystème d’innovation plus intégré, plus efficace et plus mobilisateur.

Principes de base de l’API REST API

L’API de Ideanote est une interface basée sur REST, ce qui signifie que les applications envoient des requêtes au API en accédant à des URL spécifiques via HTTPS. Chaque requête constitue une opération unique et autonome.

L’URL de base de tous les appels API est https://api.ideanote.io/v1/. Des chemins spécifiques sont ajoutés à cette URL de base pour accéder à différentes ressources. Par exemple, pour afficher la liste des collectes d’idées, l’URL est complétée par /v1/idea_collections.

L’authentification est essentielle pour utiliser le Ideanote API et nécessite d’inclure un jeton d’accès dans l’en-tête HTTP sous la forme Authorization: Bearer YOUR_TOKEN. Cela garantit un accès sécurisé aux données de votre espace de travail, limité à l’utilisateur qui a créé le jeton d’accès. De plus, tous les appels API doivent inclure un en-tête Accept: application/json indiquant que le format d’échange des données est JSON, le seul format pris en charge par le API.

Le API est organisé autour de ressources, identifiées dans l’URL et manipulées au moyen de verbes HTTP tels que GET, POST, PUT et DELETE. Ces verbes indiquent l’action que vous souhaitez effectuer, comme consulter, ajouter, mettre à jour ou supprimer.

Les paramètres jouent un rôle important dans les fonctionnalités du API : les paramètres de requête précisent les détails des requêtes GET, tandis que les données du corps de la requête sont utilisées pour les requêtes PUT et POST. Cela permet des interactions nuancées avec le API, comme parcourir les résultats par pages ou mettre à jour les données d’une ressource spécifique.

La gestion des erreurs dans le Ideanote API utilise les codes d’état HTTP standard pour indiquer la réussite ou l’échec des requêtes. Les codes courants incluent 200 en cas de réussite, 400 pour les requêtes incorrectes, 429 en cas de dépassement des limites d’utilisation et 500 pour les erreurs internes du serveur.

Structure des données de Ideanote

L’architecture de Ideanote est conçue pour refléter la nature hiérarchique et collaborative de l’innovation au sein des entreprises. Cette structure favorise une approche organisée de la gestion des idées, de leur conception à leur réalisation, dans un espace de travail numérique conçu pour optimiser l’efficacité.

Nous examinons ci-dessous les principaux composants de la structure des données de Ideanote afin d’aider les développeurs à parcourir la plateforme et à en tirer pleinement parti.

Espaces de travail : Un espace de travail constitue le niveau supérieur dans Ideanote ; il regroupe tout ce qui concerne l’innovation dans un espace centralisé où l’entreprise peut rassembler ses idées.

Sections : Les sections divisent l’espace de travail en zones visuelles plus faciles à gérer, par exemple selon les différents services ou sujets. Cela facilite l’organisation de l’innovation au sein de l’entreprise.

Collectes d’Idées : Les Collectes d’Idées regroupent les idées portant sur des sujets particuliers. Elles comprennent des phases que chaque idée doit franchir, ce qui contribue à structurer le processus de développement du début à la fin.

Phases et idées : Les phases sont les étapes que suit une idée au sein d’une collecte, de sa conception à son achèvement. Les idées en constituent les éléments fondamentaux : elles sont proposées par les utilisateurs et évoluent grâce aux commentaires, aux mentions J’aime et à leur progression dans ces phases. Chaque idée repose sur un formulaire personnalisé comprenant des champs d’idée définis par l’entreprise ; selon le contexte, différentes collectes d’idées peuvent parfois utiliser des formulaires distincts.

Utilisateurs, équipes et niveaux : Dans un espace de travail, les utilisateurs contribuent et peuvent être regroupés en équipes afin de collaborer. Les utilisateurs disposent de niveaux, tels que Propriétaire de l’espace de travail, Administrateur, Membre et Invité, qui leur accordent un accès plus ou moins étendu aux paramètres, à la création de collectes d’idées et à la gestion du contenu.

Accès et autorisations : L’accès aux collectes d’idées est géré au moyen des paramètres de partage, et non des niveaux. Ainsi, la possibilité pour un utilisateur de consulter les collectes d’idées, d’y contribuer ou d’interagir avec elles dépend du fait qu’elles soient partagées avec lui ou avec son équipe, afin que les bonnes personnes puissent se concentrer sur les tâches pertinentes.

Les développeurs trouveront davantage de détails sur les niveaux d’utilisateur et les autorisations dans le centre d’aide de Ideanote.

Accéder au API

Pour commencer à utiliser le Ideanote API, vous devez générer votre jeton d’accès API sous Paramètres > Compte > Jeton API dans l’application Ideanote.

Vous devez disposer au minimum du niveau Administrateur pour y accéder. Chaque utilisateur a accès aux entités et aux données par l’intermédiaire du API auquel il a accès en tant qu’utilisateur de l’application Ideanote.

Vous pouvez disposer de plusieurs jetons API pour les utiliser dans différentes applications ; chacun peut être révoqué individuellement.

Nos API sont gratuites pour les clients disposant d’un abonnement payant.

Exemples d’appels API

Ce tutoriel vous montrera comment effectuer votre premier appel API au Ideanote API et récupérer une liste d’idées à partir d’une collecte d’idées.

Étape 1 : générer un jeton d’accès à l’API Ideanote

Voici un tutoriel étape par étape pour l’autorisation

Vous devrez transmettre ce jeton de 43 caractères dans un en-tête Authorization de type Bearer Token pour toutes les requêtes HTTPS que vous adresserez à l’API Ideanote afin d’accéder au contenu défini dans votre compte. Voici un exemple d’en-tête d’autorisation :

Authorization: Bearer ea5b9e4********************

Étape 2 : afficher la liste des collectes d’idées via l’API

Appelez le point de terminaison des collectes d’idées pour répertorier toutes celles auxquelles votre utilisateur a accès.

curl -X GET "https://api.ideanote.io/v1/idea_collections" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <API Token>"

La commande ci-dessus renvoie un JSON structuré comme suit :

[
    {
        "id": "020166b4-8846-4896-b2ac-9074fd3a1b2c",
        "title": "Example Idea Collection",
        "question": "How might we improve the coffee?",
        "details": null,
        "stats": {
            "ideas": {
                "total": 3
            }
        },
        "cover": {
            "url": {
                "thumbnail": "https://uploads.staging.ideanote.dev/staging/v1/f985c93c-bcbd-e67f-31e5-d54f965a5fe1/download_original"
            }
        }
    }
]

Étape 3 : sélectionner une collecte d’idées et afficher la liste des idées

Appelez le point de terminaison pour répertorier les idées d’une Collecte d’Idées spécifique. Dans l’exemple ci-dessous, l’identifiant est renseigné au format ici et des paramètres d’URL permettent de renvoyer les métadonnées et les champs des idées, notamment les titres, les types et les valeurs des champs.

curl -X GET "https://api.ideanote.io/v1/idea_collections/020166b4-8846-4896-b2ac-9074fd3a1b2c/ideas?fields=id,friendlyId,keywords,status.title,phase.name,fields.{kind,title,value},owner.{firstName}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <API Token>"

Étape 4 : traiter la réponse JSON

La réponse HTTPS sera une liste d’idées au format JSON.

Chaque champ d’idée comporte un titre et une valeur. Si vous recherchez un contenu spécifique, par exemple la description d’une idée, vous pouvez rechercher le :id portant ce titre, puis traiter la valeur de ce champ d’idée. Les champs d’idée sont répertoriés par leur identifiant afin de garantir la cohérence de API, même si un champ d’idée est renommé dans l’application Ideanote.

Vous pouvez identifier à l’avance les identifiants des champs d’idée dans l’application Ideanote, sous Formulaires > Champs > Copier l’identifiant.

[
    {
        "id": "38494f31-4edc-414c-8320-e1aa8988e7aa",
        "friendlyId": 2,
        "keywords": ["bad", "idea", "bad", "idea"],
        "status": {
            "title": "On Track"
        },
        "phase": {
            "name": "Comment"
        },
        "fields": [
            {
                "kind": "LONG_TEXT",
                "title": "Description",
                "value": "This is a bad idea"
            },
            {
                "kind": "SHORT_TEXT",
                "title": "Title",
                "value": "Bad Idea"
            }
        ],
        "owner": {
            "firstName": "Test"
        }
    },
    {
        "id": "da011987-cfa9-49fa-b331-bb4ca0b2fa1b",
        "friendlyId": 1,
        "keywords": ["great", "idea", "great", "idea"],
        "status": {
            "title": "On Track"
        },
        "phase": {
            "name": "Comment"
        },
        "fields": [
            {
                "kind": "SHORT_TEXT",
                "title": "Title",
                "value": "Great Idea"
            },
            {
                "kind": "LONG_TEXT",
                "title": "Description",
                "value": "This is a great idea"
            }
        ],
        "owner": {
            "firstName": "Test"
        }
    }
]