Die Minitab Connect API

Übersicht über eine API-Anforderung

Jeder Endpunkt verfügt über eine bestimmte Liste von Attributen, die Werte enthalten, von denen einige gemeinsam genutzt werden und die mit der API-Version 3-Suchanforderung durchsucht werden können. Um die Liste der Attribute für einen Endpunkt zu erhalten, schreiben Sie eine einfache API-Anforderung Version 3. Für eine API-Anforderung der Version 3 für Endpunktattribute sind nur drei grundlegende Informationen erforderlich: Basis-URL, Endpunkt und API-Schlüssel.

Basis-URL

Die Basis-URL ist unabhängig von der spezifischen API-Anforderung identisch. Um zu bestimmen, wie Ihre Basis-URL lauten soll, kopieren Sie einfach die URL, mit der Sie sich bei Minitab Connectanmelden. Wenn Sie z. B. https://connect.minitab.com für den Zugriff auf Minitab Connectverwenden, lautet die Basis-URL für alle Ihre API-Anforderungen: https://connect.minitab.com/api/3/.

Endpunkt

Stellt das Objekt oder die Auflistung von Objekten dar, mit denen die Anforderung interagieren soll. Im obigen Beispiel ist der Endpunkt in der "Beispiel-API-Anforderung" "Quelle". Dadurch werden die Aktionen mit der API-Anforderung auf Aktionen beschränkt, die speziell für die Bearbeitung von Quelldatenobjekten entwickelt wurden.

Beispiel: Der Endpunkt in https: connect.minitab.com/Source/?apikey=12478781287471824&action=search&arg=[{"name":"Kampagnen"}] ist 'Quelle'. Dadurch werden die Aktionen mit der API-Anfrage auf Aktionen beschränkt, die speziell für die Bearbeitung von "Quell"-Datenobjekten entwickelt wurden.

Endpunkt-GUID

Die Endpunkt-GUID ist ein eindeutiger Bezeichner, der ein bestimmtes Datenobjekt in Minitab Connectdarstellt. Die GUID besteht aus einer eindeutigen Zeichenfolge und wird manchmal als "Schlüssel" bezeichnet. Um die GUID in Minitab Connectzu finden, öffnen Sie das Bearbeiten Modal für das gewünschte Objekt. Die Endpunkt-GUID ist nicht für alle API-Anforderungen erforderlich. Bei einer API-Anforderung, die eine Suchaktion ausführt, wird z. B. die Endpunkt-GUID ausgelassen.

API-Schlüssel

Dieser Teil der API-Anfrage informiert das System, dass die Anfrage mit den gleichen Berechtigungen wie der angegebene Benutzer verarbeitet werden soll. Dies wird immer durch eine GUID dargestellt. Ein API-Schlüssel ist eine eindeutige Zeichenfolge, die einem bestimmten Benutzer von Minitab Connectzugeordnet ist. Um Ihre GUID zu finden, melden Sie sich zunächst beim System an. Öffnen Sie anschließend die Benutzer Schaltfläche oben rechts und wählen Sie Kontoeinstellungenaus. Eine Liste der verfügbaren API-Schlüssel wird aufgelistet, mit der Möglichkeit, neue Schlüssel zu generieren. (In diesem Beispiel wird aus Sicherheitsgründen ein Dummy-API-Schlüssel verwendet.)

Authentifizierung

Informiert das System, dass die Anforderung mit den gleichen Berechtigungen wie der angegebene Benutzer verarbeitet werden soll. Die Authentifizierung wird durch einen API-Schlüssel dargestellt. Ein API-Schlüssel ist eine eindeutige Zeichenfolge, die erstellt wird, um Zugriff auf eine Funktion im Tool zu gewähren. Um einen API-Schlüssel zu erstellen, öffnen Sie die Benutzer Schaltfläche oben rechts und wählen Sie Kontoeinstellungenaus. Weitere Informationen finden Sie unter Generieren eines API-Tokens.

Aktion

Gibt an, welche Aktionen für den angegebenen Endpunkt ausgeführt werden sollen. Aktionen werden in der Regel wie folgt kategorisiert:

• Getter: Getter-Aktionen werden verwendet, um Daten aus dem System zu extrahieren. Jeder Endpunkt verfügt über einen eindeutigen Satz von Gettern. Um einen Getter zu verwenden, lautet das korrekte Format: action= wobei durch den Namen des gewünschten Getters ersetzt wird.
• Setter: Setter-Aktionen werden verwendet, um Daten in das System zu importieren und um Eigenschaften eines Datenobjekts festzulegen oder zu ändern. Jeder Endpunkt verfügt über einen eindeutigen Satz von Settern. Um einen Setter zu verwenden, ist das korrekte Format: action=&arg= wobei durch den Namen des gewünschten Setters ersetzt wird und der Wert ist, der gesetzt werden soll.
• Maßnahmen: Aktionen werden für Prozesse, Funktionen oder Befehle eines Datenobjekts verwendet, die nicht den Merkmalen eines Getters entsprechen. Ein Beispiel für eine Aktion ist das Hinzufügen von Feldern zu einer Tabelle. Jede Aktion hat unterschiedliche Anforderungen. Einige Aktionen erfordern z. B. keine Argumente und sind auf die gleiche Weise wie ein Getter formatiert. Andere Aktionen erfordern, dass Argumente wie ein Setter formatiert werden.
• Suchen: Suchvorgänge werden verwendet, um Daten von einem Endpunkt abzurufen, der einen bestimmten Satz von Parametern erfüllt. Suchen können eine unendliche Anzahl von Suchbegriffen haben und sind als Array formatiert. Zum Beispiel: action=search&args=[{"fname":"John","lname":"Smith"}] würde nur Datensätze zurückgeben, bei denen [ "fname" (Vorname) ist "John" UND "lname" (Nachname) "Smith"ist. Sie können beliebig viele Suchbegriffe verwenden, solange sie in die Schlüssel:Wert-Struktur passen und durch Kommas getrennt sind.

  Hinweis

  Beim Hinzufügen der Werte zur API-Suchanforderung müssen Textzeichenfolgen in Anführungszeichen stehen.

Sie können eine API-Anforderung stellen, die mehrere Aktionen enthält. Trennen Sie dazu jede Aktion durch ein kaufmännisches Und-Zeichen ("&"). Sie müssen z. B. den Vornamen, den zweiten Vornamen und den Nachnamen eines Benutzers mit der ID 15 ändern. Die Anforderung sieht folgendermaßen aus:

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

Diese Anforderung legt den Vornamen auf "John",den zweiten Vornamen auf "D" und den Nachnamen auf "Smith" für den Benutzer mit der ID 15fest.

Hinweis

Wenn Sie mehrere Aktionen in einer einzigen API-Anforderung verwenden, muss die Aktion inkrementiert werden. Die erste Aktion und das erste Argument können mit 0 oder 1 angehängt werden. Jede zusätzliche Aktionsgruppierung muss um den Faktor 1 erhöht werden.

API-Anfrage zum Zurückgeben aller Aktionen für einen Endpunkt

Zu jedem Zeitpunkt kann eine API-Anfrage gestellt werden, die eine Liste aller Aktionen zurückgibt, die für einen bestimmten Endpunkt verfügbar sind. Die Anfrage lautet wie folgt:

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

Ersetzen Sie den Endpunkt durch den spezifischen Endpunkt und apikey durch einen tatsächlichen API-Schlüssel. Es wird ein JSON-Objekt zurückgegeben, das alle Aktionen für den Endpunkt sowie alle Attribute enthält.

Aktuelle Endpunkte und Beschreibungen

Sie können jederzeit eine API-Anforderung stellen, die eine Liste aller Endpunkte zurückgibt. Die Anfrage lautet wie folgt:

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