Technical use case : Exploitation de GoFAST REST API (python...)

Topic created · 1 Posts · 12 Views
  • Bonjour à tous !

    Nous avons de plus en plus de demandes d'automatisation et de couplages avec GoFAST API en utilisant des outils ou des solutions externes. Pour répondre à ce besoin nous recenserons ici des use case techniques d'exploitation de notre API.

    Pour l'accès complet aux ressources, vous pouvez consulter la Documentation en ligne.


    Python
    En python, il est facile d'exploiter GoFAST REST API en utilisant les librairies requests et json

    import requests
    import json
    

    Il faut ensuite définir les variables qu'on va utiliser pour communiquer avec l'API, ici nous avons l'URL, les headers et les data
    Nous utiliserons dans cet exemple l'API de création d'espace, accessible en utilisant l'URL /api/space/space de votre GoFAST avec la méthode PUT
    Dans les headers pour la partie Authorization, il vous faudra utiliser une authentification Basic comme décrit dans cette partie de notre documentation
    Dans les data, le gid correspond à l'espace dans lequel vous souhaitez créer votre espace, tous les paramètres disponibles sont décrits dans la documentation.

    url = "https://gofast.ceo-vision.com/api/space/space"
    headers = {'Content-Type': "application/json", 'Authorization': "Basic user:password(Base 64 encoded)"}
    data = {'gid': '4', 'title': 'API space'}
    

    Enfin, il vous suffit d'effectuer la requête vers votre serveur GoFAST

    print requests.put(url, data=json.dumps(data), headers=headers).text
    

    Vous aurez alors un retour sous la forme décrite dans la partie retour de la documentation

    {"gid":"2619"}
    

    Le code complet :

    import requests
    import json
    
    url = "https://gofast.ceo-vision.com/api/space/space"
    headers = {'Content-Type': "application/json", 'Authorization': "Basic user:password(Base 64 encoded)"}
    data = {'gid': '4', 'title': 'API space'}
    
    print requests.put(url, data=json.dumps(data), headers=headers).text
    

    N'hésitez pas à échanger à ce sujet dans ce topic !

Log in to reply