Skip to main content

Accès de l’API à TOPdesk

Fonctionnalités et exigences de l’API

TOPdesk est livré avec une interface de programmation d'applications (API, application programming interface). Cette application vous permet d'intégrer d'autres systèmes à TOPdesk. Par exemple, vous pouvez ajouter un widget à votre intranet afin de montrer les tickets ou réservations en cours à vos utilisateurs, ou encore intégrer votre système de surveillance afin que les utilisateurs puissent enregistrer directement des tickets dans TOPdesk.

remarque

Vous pouvez accéder à l'API via https://[URLTOPdesk]/tas/api/.

Quels processus l'API prend-elle en charge ?

L'étendue de la prise en charge par l'API diffère selon le processus. Nous augmentons constamment le nombre de processus pris en charge. Pour connaître toutes les API disponibles, veuillez consulter notre page de documentation sur les API de TOPdesk.

Il ne s'agit pas d'un guide pour débutants : public cible du manuel API

Le manuel API vous guidera à travers les étapes nécessaires pour accéder à l'API de TOPdesk, la consulter et l'utiliser afin de récupérer des données de TOPdesk. Cependant, les techniques utilisées ne seront pas expliquées : HTTP, REST et JSON. Afin de comprendre et d'utiliser ce manuel, vous devez connaître le modèle de données de TOPdesk et le format de données JSON.

Exigences pour accéder à l’API

Avant d’accéder à l’API, vous devez d’abord :

  1. Activez Authentification TOPdesk et/ou authentification LDAP dans la Section Spécialistes de votre environnement TOPdesk.

  2. Créer un utilisateur qui appellera l'API. Nous vous recommandons de créer un compte Spécialiste ou Personne distinct pour chaque application nécessitant l'accès à l'API, pour une résolution aisée des problèmes. La nécessité de créer un compte Spécialiste ou Personne dépend du domaine (Section Spécialistes ou Portail Utilisateurs) auquel vous voulez accéder. Assurez-vous que l'utilisateur dispose de données de connexion TOPdesk et/ou LDAP.

  3. Créer un groupe de permissions autorisant l'utilisation de l'API. Attribuez des permissions de lecture pour REST API et des permissions d'écriture pour Utiliser les mots de passe de l'application (dans le bloc de permissions Accès à l'API).

  4. Lier l'/les utilisateur(s) API à ce groupe de permissions API et à d'autres groupes de permissions nécessaires pour accéder aux sections souhaitées de TOPdesk.

  5. Installer un outil permettant de créer et de tester des requêtes HTTP. Dans ce manuel, vous verrez des exemples avec l'extension Chrome Talend API Tester (anciennement connue sous le nom de Restlet Client). Certaines instructions sont spécifiques à cet outil, mais vous pouvez utiliser d'autres outils si vous le souhaitez. La plupart des outils fonctionnent de la même manière.

    L'extension Talend API Tester apparaît sous la forme d'une icône polygone mauve dans votre navigateur. Cliquez sur cette icône pour ouvrir l'extension.

Dans cette section​: