Procédure pour utiliser l'API WEB de TeamGant (en utilisant python)

Qu'est-ce que Team Gant

• TeamGant est, comme son nom l'indique, un service qui permet aux membres de l'équipe de partager des diagrammes de Gantt.
• Vous pouvez également gérer des tâches, etc.
• Disponible dans les navigateurs. Il semble y avoir une application dédiée pour smartphone.

Que présenter cette fois

• Présentation de la procédure d'utilisation de l'API WEB de TeamGant.
• Voici un exemple utilisant Python.
• Cette fois, __ Seule l'introduction de la méthode d'accès de base __.

Que puis-je faire?

• Les contrôles de progression quotidiens peuvent être scriptés en utilisant le navigateur sans cliquer.

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

Comment commencer

1. Commencez par créer un compte pour TeamGant. (La version gratuite est également disponible)
2. Faites un projet et faites un processus
3. Émettre __Bearer Token __
4. Obtenez __User Token __ et __API Key __
5. Testez la commande seule sur la page de référence de l'API
6. Code en Python.

• Cette fois, nous expliquerons WEB API, donc nous expliquerons à partir de __ 3. Emission d'un jeton au porteur __.

Comment émettre un jeton porteur

1. Accédez à la page [Jetons d'application] de TeamGant (https://app.teamgantt.com/admin/app-tokens).
2. Entrez un nom approprié dans __New App Name __ et appuyez sur Save.
3. Un jeton (chaîne de caractères longue) sera retourné à Token, donc copiez-le.

Émission de jetons utilisateur et de clés API

• Accédez à la [page de document API] de TeamGant (https://teamgantt.docs.apiary.io/#).
• Cliquez sur "Authentification" ⇒ "Créer une session".
• Puisqu'il y a une fenêtre sur le côté droit où vous pouvez essayer l'API, entrez le jeton porteur que vous avez obtenu plus tôt dans le jeton porteur ("Bearer ABC123" est entré par défaut).

• Notez que "Bearer" est requis au début du jeton porteur! (Entrez un espace)

• Appuyez sur l'onglet Body et remplacez l'utilisateur et passez par le vôtre.

• Appuyez sur le bouton __Call Resource __

En cas de succès, Response sera dans les années 200. Si c'est dans les années 400, c'est une erreur, veuillez donc vérifier les paramètres.

Les chaînes de caractères api_key et user_token sont renvoyées dans Response Body, alors notez-les.

Pratiquez sur la page de référence de l'API

Vous pouvez tester votre API sur la page de référence de l'API. En utilisant GetList, une API liée aux tâches, à titre d'exemple, je vais vous expliquer la procédure pour obtenir la liste des tâches de votre journée.

Sélection de commande

Sélectionnez Task ⇒ Tasks dans l'en-tête de gauche et appuyez sur Get List. La fenêtre de droite est prête à essayer la commande __ / tasks? Today__.

Ensuite, ajoutez le jeton __bearer, le jeton utilisateur et la clé API __ à l'en-tête de l'URL.

Appuyez sur Headers puis sur Add new header pour saisir le nom et la valeur de l'élément.

L'écran comme ↓ s'affiche lorsque les trois ci-dessus sont définis comme En-tête. Si vous appuyez sur Ressource d'appel et que la série Réponse 200 est renvoyée, c'est OK.

Avec la procédure ci-dessus, vous pouvez essayer l'API dans le document API sur le navigateur.

Les en-têtes __API peuvent être épinglés! __ Vous pouvez l'épingler en déplaçant le curseur de la souris sur le côté droit de la zone de saisie. Si vous l'épinglez, vous n'avez pas à saisir l'en-tête à chaque fois que vous modifiez la commande API, ce qui est facile.

Exemple utilisant Python

La documentation API de TeamGant contient également un exemple Python. Voici un exemple que j'ai essayé.

• L'accès WEB_API utilise urllib.
• La réponse reçue est interprétée comme JSON à l'aide de la bibliothèque json et transformée en un type de dictionnaire.
• J'écris le json GET dans un fichier.

# -*- coding: utf-8 -*-
import urllib.request
import codecs
import json
########################################################################
# TeamGant
########################################################################
class TeamGant():
    '''
constructeur
    '''
    def __init__(self):
        self.APIheader={'TG-Authorization':'Bearer <Jeton propre porteur>'
                       ,'TG-Api-Key'      :'<Propre clé API>'
                       ,'TG-User-Token'   :'<Propre jeton d'utilisateur>'
                       }
        self.UrlBase = 'https://api.teamgantt.com/v1/'
    '''
Faire une demande à TeamGant
Argument ApiCmd: commande API(Obligatoire)
Argument iSaveName: nom de fichier spécifié lorsque vous souhaitez écrire le résultat dans un fichier json Body
    '''
    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')) #Exportation
        return __json
    '''
Obtenez la tâche d'aujourd'hui
    '''
    def GetTodayTask(self):
        cmd='tasks?today'       #Tâche d'aujourd'hui
        return self._gatTGjson(cmd, 'TaskToday')

########################################################################
#Fonction principale
########################################################################
if __name__ == '__main__':
    tg = TeamGant()             #Créer une classe TeamGant
    js = tg.GetTodayTask()      #Exécutez la méthode pour obtenir la tâche du jour et recevoir json
    json_dict = json.loads(js)  #Faire du json reçu un type de dictionnaire