L’API Minitab Connect

Aperçu d’une requête API

Chaque point de terminaison possède une liste spécifique d’attributs contenant des valeurs, certaines partagées et d’autres uniques, pouvant être consultées via la requête de recherche API version 3. Pour recevoir la liste des attributs d’un point de terminaison, écrivez une requête API simple version 3. Une requête API version 3 pour les attributs du point de terminaison ne nécessite que trois informations de base : l’URL de base, le point de terminaison et la clé API.

Base URL

L’URL de base reste la même, quel que soit le type de requête API effectuée. Pour déterminer quelle doit être votre URL de base, il suffit de copier l’URL que vous utilisez pour vous connecter à Minitab Connect. Par exemple, si vous utilisez https://connect.minitab.com pour accéder Minitab Connect à , alors l’URL de base pour toutes vos requêtes API est : https://connect.minitab.com/api/3/.

Extrémité

Représente l’objet ou la collection d’objets avec lesquels la requête est destinée à interagir. Dans l’exemple ci-dessus, le point d’extrémité dans la « Requête API d’exemple » est « Source ». Cela limitera ce qui peut être fait avec la requête API aux actions spécifiquement conçues pour manipuler les objets de données « source ».

Par exemple, le point de terminaison en https : connect.minitab.com/Source/?apikey=12478781287471824&action=search&arg=[{"name » :"Campaigns"}] signifie « Source ». Cela limitera ce qui peut être fait avec la requête API aux actions spécifiquement conçues pour manipuler les objets de données « source ».

GUID de point de terminaison

Le GUID du point de terminaison est un identifiant unique qui représente un objet de données spécifique dans Minitab Connect. Le GUID se compose d’une chaîne unique de caractères et est parfois appelé une « Clé ». Pour trouver le GUID dans Minitab Connect, ouvrez le Modifier modal de l’objet désiré. Le GUID du point de terminaison n’est pas requis pour toutes les requêtes API. Par exemple, une requête API qui effectue une action de recherche omet le GUID du point de terminaison.

Clé API

Cette partie de la requête API informe le système que la requête doit être traitée avec les mêmes permissions que l’utilisateur spécifié. Cela sera toujours représenté par un GUID. Une clé API est une chaîne unique de caractères associée à un utilisateur spécifique de Minitab Connect. Pour trouver votre GUID, connectez-vous d’abord au système. Ensuite, ouvre le Utilisateur bouton en haut à droite et sélectionnez Paramètres du compte. Une liste de clés API disponibles est listée avec la possibilité d’en générer de nouvelles. (Dans cet exemple, une clé API factice est utilisée à des fins de sécurité)

Authentification

Informe le système que la demande doit être traitée avec les mêmes permissions que l’utilisateur spécifié. L’authentification est représentée par une clé API. Une clé API est une chaîne unique de caractères créée pour donner accès à une fonctionnalité de l’outil. Pour créer une clé API, ouvrez le Utilisateur bouton en haut à droite et sélectionnez Paramètres du compte. Pour plus d’informations, consultez la page Générer un jeton API.

Action

Précise quelles actions entreprendre pour le point de terminaison spécifié. Les actions sont généralement classées comme suit :

• Obteneurs: Les actions getter sont utilisées pour extraire des données du système. Chaque extrémité possède un ensemble unique de getters. Pour utiliser un getter, le format correct est : action = où est remplacé par le nom du getter désiré.
• Passeurs: Les actions de réglage sont utilisées pour importer des données dans le système et pour définir ou modifier les propriétés d’un objet de données. Chaque extrémité possède un ensemble unique de setters. Pour utiliser un passeur, le format correct est : action=&arg= où est remplacé par le nom du setter désiré et est la valeur à fixer.
• Actions: Les actions sont utilisées pour des processus, des fonctionnalités ou des commandes d’un objet de données qui ne répondent pas aux caractéristiques d’un getter. Un exemple d’action est d’ajouter des champs à une table. Chaque action a des exigences différentes. Par exemple, certaines actions ne nécessitent aucun argument et sont formatées de la même manière qu’un receveur. D’autres actions nécessitent que les arguments soient formatés comme un poseur.
• Recherches: Les recherches servent à obtenir des données d’un point de terminaison qui répond à un ensemble spécifique de paramètres. Les recherches peuvent comporter un nombre infini de termes de recherche et sont formatées en tableau. Par exemple : action=search&args=[{"fname » :"John », « lname » :"Smith"}] ne retournerait que des enregistrements où [ « fname » (prénom) est « John » ET « lname » (nom de famille) est « Smith». Vous pouvez utiliser n’importe quel nombre de termes de recherche tant qu’ils correspondent à la structure clé :valeur et sont séparés par des virgules.

  Remarque

  Lors de l’ajout des valeurs à la requête de recherche API, les chaînes de texte doivent être à l’intérieur de guillemets.

Vous pouvez faire une requête API contenant plusieurs actions. Pour ce faire, séparez chaque action avec un esperluet ('&'). Par exemple, vous devez changer le prénom, le deuxième prénom et le nom de famille d’un utilisateur ayant un identifiant de 15. La demande ressemble à ceci :

https://connect.minitab.com/api/3/User/15?apikey=45a3d34982e&action0=setFName&arg0=John&action1=setMName&arg1=D&action2=setLName&arg2=Smith

Cette requête fixe le Prénom égal à « John »,le Deuxième Prénom à « D » et le Nom de famille à « Smith » sur l’utilisateur ayant un ID de 15.

Remarque

Lors de l’utilisation de plusieurs actions dans une même requête API, l’action doit être incrémentée. La première action et l’argument peuvent être ajoutés avec un 0 ou un 1. Chaque regroupement d’actions supplémentaire doit augmenter d’un facteur 1.

Requête API pour retourner toutes les actions d’un point de terminaison

À tout moment, une requête API peut être effectuée pour retourner une liste de toutes les actions disponibles à un point de terminaison spécifique. La demande est la suivante :

https://connect.minitab.com/api/3/[point de terminais]/ ?apikey=[apikey]

Remplacez le point de terminaison par le point de terminaison spécifique et apikey par une clé API réelle. Un objet JSON sera retourné contenant toutes les actions du point de terminaison ainsi que tous les attributs.

Points de terminaison actuels et descriptions

À tout moment, vous pouvez faire une requête API qui retournera une liste de tous les points de terminaison. La demande est la suivante :

https://connect.minitab.com/api/3/?apikey=[apikey]