Carnet d'exemples d'API Braincube - Démarrage rapide
Ce carnet décrit comment utiliser l'API Braincube pour commencer à l'utiliser en utilisant un exemple de base.
Dans ce carnet, nous allons vérifier:
- Comment configurer votre environnement Python
- Comment s'authentifier à l'aide d'un jeton d'accès personnel
- Comment commencer à interroger les données dans un dataframe
Configuration
Installez les packages nécessaires comme suit s'ils ne sont pas déjà installés:
In [ ]:
%%capture
#!pip install py_client-0.0.0/py_client-0.0.0-py3-none-any.whl
!pip install braincube_connector
!pip install braincube-token-getter
Vérifiez les packages installés sur l'environnement actuel
In [ ]:
%%capture
!pip freeze
Configuration de l'environnement Python
In [ ]:
from braincube_connector import client
from braincube_connector import braincube
In [ ]:
import json
import pandas as pd
Authentification
Depuis la version 2.2.0, l'authentification utilise un jeton d'accès personnel (PAT).
Pour créer un PAT, vous devez aller dans votre menu personnel Braincube > Compte > Jetons d'accès > +/Ajouter
Les portées du jeton doivent inclure BRAINCUBE et SSO_READ.
Ensuite, deux options existent pour transmettre le PAT au braincube_connector:
Utilisation d'un dictionnaire de configuration lors de la création d'un client:
from braincube_connector import client
client.get_instance(config_dict={"api_key":"", "domain":"mybraincube.com"})
Utilisation d'un fichier de configuration:
from braincube_connector import client
client.get_instance("config_file"="myfile.json")
myfile.json contenu:
{"api_key":"<my_personal_access_tok