L’API Minitab Connect OData

Base URL

L’URL de base est la même quel que soit le type de requête API que vous faites. Pour déterminer quelle doit être votre URL de base, copiez l’URL que vous utilisez pour vous connecter à Minitab Connect et ajoutez /api/odata_v4/. 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 OData est : https://connect.minitab.com/api/odata_v4/.

Méthodes d’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 qui donne accès à une fonctionnalité de l’outil. Pour créer une clé API, ouvrez Utilisateur le menu en haut à droite et sélectionnez Paramètres du compte. Pour plus d'informations, reportez-vous à la rubrique Générer un jeton API.

Il existe trois méthodes d’authentification différentes.

Clé API de chaîne de requête

Un paramètre GET ou POST nommé « apikey » contient un jeton généré par la page de Paramètres de Connexion du Compte. Par exemple, https://connect.minitab.com/api/odata_v4/?apikey=[apikey], où vous remplacez « apikey » par la clé API réelle.

Clé API d’en-tête

Un en-tête HTTP nommé « X-Api-Key » contient un jeton généré par la page Paramètres de Connexion du Compte.

Authentification Web de base

Votre nom d’utilisateur est votre nom d’utilisateur ou votre adresse e-mail Connect. Le mot de passe est un jeton généré par la page Paramètres de Connexion de Compte.

Terminaison

Terminaison de base - https://connect.minitab.com/api/odata_v4/

Retourne une liste d’ensembles d’entités qui sont les tables et vues auxquelles l’utilisateur a accès.

Remarque

Connectez les distances à distance tous les caractères non A-Z, a-z, 0-9, acc-(trait d’union) et _(sous-trait) provenant des entités (enregistrements), ensembles d’entités (tables et vues) et propriétés. Connect ajoute « _t » pour les tables et « _v » pour les vues, ainsi qu’un identifiant aux noms d’entités et d’ensembles d’entitty pour garantir un nom unique. Par exemple :

• TableName_t38
• ViewName_v2

Endpoint de métadonnées - https://connect.minitab.com/api/odata_v4/$metadata

Retourne la définition des données XML de toutes les entités, ensembles d’entités et propriétés.

Terminaison Entity Set - https://connect.minitab.com/api/odata_v4/[EntitySet]

Retourne les enregistrements depuis l’ensemble d’entités (table ou vue). Par défaut, l’ordre correspond à celui de la Base ou de l’ordre de la Vue. Remplacez le 'EntitySet' par le nom correspondant de la table ou de la vue Minitab Connect. Vous pouvez renvoyer les noms de toutes les tables et vues depuis le point d’extrémité de base.

Le point d’extrémité de l’ensemble d’entités ne prend actuellement en charge que trois fonctions :

$count - https://connect.minitab.com/api/odata_v4/[EntitySet]/ ?$count

Retour du nombre de records

$top - https://connect.minitab.com/api/odata_v4/[EntitySet]/ ?$top=[nombre]

Retourne les enregistrements « numéros » de l’ensemble d’entités. Le nombre par défaut et le maximum sont tous deux 5 000 enregistrements. Vous pouvez combiner avec $skip pour feuilleter tous les dossiers.

$skip - https://connect.minitab.com/api/odata_v4/[EntitySet]/ ?$skip=[nombre]

Saute les disques « numérotés ». Vous pouvez combiner avec $top pour feuilleter tous les dossiers.

Remarque

Le point d’extrémité de l’ensemble d’entités ne prend actuellement pas en charge les fonctions $filter, $select, $orderby ou $expand. Vous pouvez créer le même effet de $filter, $select et $orderby en utilisant l’outil Préparation et Minitab Connect en créant une vue sauvegardée de votre table.

Extrémité d’entité - https://connect.minitab.com/api/odata_v4/[EntitySet]([sys_id])/

Retourne une entité (un enregistrement), identifiée par « sys_id », à partir de l'« EntitySet » spécifié.