Amostra de Notebook de API Braincube - Início rápido
Este notebook descreve como usar a API Braincube para começar a usá-la com um exemplo básico.
Neste notebook, vamos verificar:
- Como configurar seu ambiente Python
- Como autenticar usando um token de acesso pessoal
- Como começar a consultar dados em um dataframe
Configuração
Instale os pacotes necessários conforme segue se ainda não estiverem instalados:
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
Verifique os pacotes instalados no ambiente atual
In [ ]:
%%capture
!pip freeze
Configurando o ambiente Python
In [ ]:
from braincube_connector import client
from braincube_connector import braincube
In [ ]:
import json
import pandas as pd
Autenticação
Desde a versão 2.2.0, a autenticação usa um token de acesso pessoal (PAT).
Para criar um PAT, você precisa ir no seu menu pessoal do Braincube > Conta > Tokens de acesso > +/Adicionar
Os escopos do token devem incluir BRAINCUBE e SSO_READ.
Em seguida, duas opções existem para passar o PAT para o braincube_connector:
Usando um dicionário de configuração ao criar um cliente:
from braincube_connector import client
client.get_instance(config_dict={"api_key":"", "domain":"mybraincube.com"})
Usando um arquivo de configuração:
from braincube_connector import client
client.get_instance("config_file"="myfile.json")
myfile.json conteúdo:
{"api_key":"<my_personal_access_tok