Vorgehensweise zur Verwendung der WEG-API von TeamGant (mit Python)

Was ist Team Gant?

• TeamGant ist, wie der Name schon sagt, ein Dienst, mit dem Teammitglieder Gantt-Diagramme teilen können.
• Sie können auch Aufgaben usw. verwalten.
• In Browsern verfügbar. Es scheint eine dedizierte Smartphone-App zu geben.

Was diesmal einzuführen

• Einführung in das Verfahren zur Verwendung der WEB-API von TeamGant.
• Hier ist ein Beispiel mit Python.
• Diesmal __ Nur die Einführung der grundlegenden Zugriffsmethode __.

Was kann ich tun?

• Tägliche Fortschrittsprüfungen können per Skript ausgeführt werden, indem der Browser ohne Klicken betrieben wird.

https://support.teamgantt.com/article/132-teamgantt-api

Wie man anfängt

1. Erstellen Sie zunächst ein Konto für TeamGant. (Kostenlose Version ist ebenfalls verfügbar)
2. Machen Sie ein Projekt und machen Sie einen Prozess
3. Geben Sie __Bearer Token __ aus
4. Holen Sie sich __User Token __ und __API Key __
5. Testen Sie den Befehl allein auf der API-Referenzseite
6. Code in Python.

• Dieses Mal erklären wir WEB API, also erklären wir ab __3. Ausgabe des Bearer Token __.

So stellen Sie einen Inhaber-Token aus

1. Gehen Sie zur Seite [App Tokens] von TeamGant (https://app.teamgantt.com/admin/app-tokens).
2. Geben Sie unter New App Name einen geeigneten Namen ein und drücken Sie Save.
3. Ein Token (lange Zeichenfolge) wird bei Token zurückgegeben. Kopieren Sie es also.

Ausgabe von Benutzertoken und API-Schlüsseln

• Gehen Sie zur [API-Dokumentenseite] von TeamGant (https://teamgantt.docs.apiary.io/#).
• Klicken Sie auf "Authentifizierung" ⇒ "Sitzung erstellen".
• Da sich auf der rechten Seite ein Fenster befindet, in dem Sie die API testen können, geben Sie das zuvor im Inhaber-Token erhaltene Inhaber-Token ein (standardmäßig wird "Träger ABC123" eingegeben).

• Beachten Sie, dass "Träger" am Anfang des Inhaber-Tokens erforderlich ist! (Geben Sie ein Leerzeichen ein)

• Drücken Sie die Registerkarte Body und ersetzen Sie den Benutzer und übergeben Sie ihn durch Ihren eigenen.

• Klicken Sie auf die Schaltfläche __Call Resource __

Bei Erfolg wird Response in den 200ern sein. Wenn es in den 400er Jahren ist, handelt es sich um einen Fehler. Überprüfen Sie daher die Einstellungen.

Die Zeichenfolgen api_key und user_token werden in Response Body zurückgegeben. Notieren Sie sich diese.

Üben Sie auf der API-Referenzseite

Sie können Ihre API auf der API-Referenzseite testen. Am Beispiel von GetList, einer API für Aufgaben, erkläre ich das Verfahren zum Abrufen der Aufgabenliste für Ihren Tag.

Befehlsauswahl

Wählen Sie Task ⇒ Tasks aus der Überschrift links und drücken Sie Get List. Das Fenster rechts ist bereit, den Befehl __ / task? Today__ auszuführen.

Fügen Sie als Nächstes __bearer-Token, Benutzertoken und API-Schlüssel __ zum URL-Header hinzu.

Drücken Sie Headers und dann Add new header, um den Elementnamen und den Wert einzugeben.

Der Bildschirm wie ↓ wird angezeigt, wenn die obigen drei als Header festgelegt sind. Wenn Sie auf Call Resource drücken und die Serie Response 200 zurückgegeben wird, ist dies in Ordnung.

Mit dem oben beschriebenen Verfahren können Sie die API im API-Dokument im Browser testen.

__API-Header können angeheftet werden! __ __ Sie können es anheften, indem Sie den Mauszeiger auf die rechte Seite des Eingabefelds bewegen. Wenn Sie es anheften, müssen Sie den Header nicht jedes Mal eingeben, wenn Sie den API-Befehl ändern, was einfach ist.

Beispiel mit Python

Die API-Dokumentation von TeamGant enthält auch ein Python-Beispiel. Hier ist ein Beispiel, das ich versucht habe.

• Der WEB_API-Zugriff verwendet urllib.
• Die empfangene Antwort wird unter Verwendung der JSON-Bibliothek als JSON interpretiert und in einen Wörterbuchtyp umgewandelt.
• Ich schreibe den GET json in eine Datei.

# -*- coding: utf-8 -*-
import urllib.request
import codecs
import json
########################################################################
# TeamGant
########################################################################
class TeamGant():
    '''
Konstrukteur
    '''
    def __init__(self):
        self.APIheader={'TG-Authorization':'Bearer <Eigener Inhaber-Token>'
                       ,'TG-Api-Key'      :'<Eigener API-Schlüssel>'
                       ,'TG-User-Token'   :'<Eigenes Benutzertoken>'
                       }
        self.UrlBase = 'https://api.teamgantt.com/v1/'
    '''
Stellen Sie eine Anfrage an TeamGant
Argument ApiCmd: API-Befehl(Verpflichtend)
Argument iSaveName: Dateiname, der angegeben wird, wenn Sie das Ergebnis in einen JSON-Dateikörper schreiben möchten
    '''
    def _gatTGjson(self, ApiCmd="",iSaveName=""):
        __request = urllib.request.Request(self.UrlBase + ApiCmd, headers=self.APIheader)
        __response = urllib.request.urlopen(__request)
        __json = __response.read().decode("utf-8")
        if not len(iSaveName) == 0:
            print(__json, file=codecs.open('./' + iSaveName + '.json' , mode='w')) #Export
        return __json
    '''
Holen Sie sich die heutige Aufgabe
    '''
    def GetTodayTask(self):
        cmd='tasks?today'       #Die heutige Aufgabe
        return self._gatTGjson(cmd, 'TaskToday')

########################################################################
#Hauptfunktion
########################################################################
if __name__ == '__main__':
    tg = TeamGant()             #Erstellen Sie eine TeamGant-Klasse
    js = tg.GetTodayTask()      #Führen Sie die Methode aus, um die heutige Aufgabe abzurufen und json zu erhalten
    json_dict = json.loads(js)  #Machen Sie den empfangenen JSON zu einem Wörterbuchtyp