Credenciais

Nós utilizamos o protocolo de autorização OAuth 2.0 para conceder autorização na nossa API. Isso significa que as credenciais de acesso são definidas por dois identificadores, a saber, um CLIENT_ID e um CLIENT_SECRET (eles funcionam como um usuário e senha para seu site ou aplicativo)

O clientId é um identificador único público usado pela nossa API para identificar o seu site ou aplicativo e usado para criar URLs de autorização.

O clientSecret é um identificador privado usado para detectar a identidade do seu site ou aplicativo quando ele solicita o acesso aos dados de um usuário, ele deve ser sempre mantido privado, pense nele como se fosse uma senha.

Você também precisará cadastrar uma URL de redirecionamento conhecida como CALLBACK_URL (comumente chamada também de REDIRECT_URI). Isso porque o nosso produto é integrado na experiência da sua plataforma e portanto precisamos saber para onde redirecionar o usuário de volta assim que o usuário aceitar o compartilhamento de dados financeiros. Para garantir a segurança dos dados, só redirecionamos o usuário para a URL que foi previamente cadastrada.

A callbackURL é a url de redirecionamento usada para redirecionarmos o usuário de volta para sua plataforma. Caso não possua uma plataforma, será usada uma URL padrão do próprio Guiabolso Connect e não haverá redirecionamento de volta.

Como faço para me registrar?

Envie um email para o nosso comercial com a URL de redirecionamento que você deseja cadastrar e enviaremos de volta suas credenciais com o seu respectivo client ID e client Secret.

Se você não possuir uma URL de redirecionamento e uma plataforma, e mesmo assim quiser testar o quick start e a integração localmente, basta nos avisar pelo email que realizaremos seu cadastro com uma URL padrão.

Considerações Finais

Se o leitor não estiver muito familiarizado com o protocolo de autorização OAuth 2.0 e os termos envolvidos como código de autorização ou token de acesso e quiser entender mais sobre o assunto, nós recomendamos a seguinte leitura, mas é importante salientar que não é necessário nenhum conhecimento prévio sobre OAuth 2.0 para conseguir integrar o nosso produto, vamos explicar passo a passo como você deve fazer.