Abrir a Experiência

Existem basicamente duas formas de integrar o nosso produto na experiência da sua plataforma, por meio de redirecionamento ou por meio de um modal. Independente de qual seja o caso, a URL usada deve ser a URL de integração e deve ser montada com alguns parâmetros específicos.

URL de Integração

A URL de integração precisa receber alguns parâmetros, como por exemplo a seguinte URL. O email e telefone são opcionais porque estes dados são usados para pré-preencher a tela de cadastro, para que o usuário não precise digitar tudo de novo. O CLIENT_ID e a CALLBACK_URL foram fornecidas a você quando você requisitou seu acesso por email e por fim, vale lembrar que a callback e fallback URL devem ser sempre decodificadas em UTF-8.

COPIAR

https://connect.guiabolso.com.br/#/integracao
   ?email=user@gmail.com
   &cpf=999999999999
   &phone=11999999999
   &userTrackingId=273117c3-e374-436c-a7ad-adba544872ba
   &clientId=<CLIENT_ID>
   &callbackURL=<CALLBACK_URL>
   &fallbackURL=https%3A%2F%2Fconnect.guiabolso.com.br%2F

Glossário de Parâmetros

Parâmetro		Descrição
`cpf`	OBRIGATÓRIO	CPF do usuário em formato numérico, por exemplo, 99999999999
`email`	OPCIONAL	Email do usuário, por exemplo, user@gmail.com
`phoneNumber`	OPCIONAL	Telefone do usuário com DDD em formato numérico, por exemplo, 11999999999
`userTrackingId`	OBRIGATÓRIO	Esse ID do usuário deve ser único e não sensível, ou seja, não use o CPF do usuário aqui mas use um UUID, por exemplo, `273117c3-e374-436c-a7ad-adba544872ba`. Esse campo será usado para rastrearmos seu usuário dentro da nossa plataforma.
`clientId`	OBRIGATÓRIO	ID da sua chave de API
`callbackURL`	OBRIGATÓRIO	URL de redirecionamento quando o usuário clicar em "Compartilhar Análise", enviaremos o usuário para essa URL, por padrão definido como `https://connect.guiabolso.com.br/`
`fallbackURL`	OBRIGATÓRIO	URL de redirecionamento quando o usuário fechar o modal ou a janela em qualquer momento, por padrão definido como `https://connect.guiabolso.com.br/`

Por Meio de Redirecionamento

Você pode simplesmente redirecionar o usuário pra URL de integração para abrir a nossa experiência. Quando o usuário terminar e clicar em Compartilhar Análise na última tela da nossa experiência, nós redirecionaremos o usuário de volta para sua plataforma através da CALLBACK_URL e enviaremos o código de autorização dentro dessa URL.

Por exemplo, supondo que sua callback URL seja https://meusite.com o redirecionamento será feito para a seguinte URL. Você severá receber esse código e ser capaz de chamar a nossa API pra trocar esse código por tokens de acesso.

COPIAR

https://meusite.com/?authCode=<AUTH_CODE>

O código de autorização é válido por 60 minutos. Isso significa que você tem apenas 60 minutos para pedir autorização para nossa API em nome do usuário usando esse código.

Por meio de um Modal

Alternativamente, você pode criar um botão e abrir o modal do Connect quando o usuário clicar no botão, como no exemplo abaixo, nós recomendamos que o tamanho do modal seja de 992 x 800.

COPIAR

<button onclick="openGuiabolsoConnect()">Guiabolso Connect</button>
<script>
  function openGuiabolsoConnect() {
    window.open("https://connect.guiabolso.com.br/#/integracao?{params}",
      "gbConnectWindow",
      "width=992,height=800"
    );
  }
</script>

Você precisa também cadastrar um Listener para o evento de retorno e receberá o código de autorização do usuário dentro do campo message.data, como mostrado abaixo.

COPIAR

window.addEventListener("message", handleGBData, false);
function handleGBData(message) {
   if(message.origin === "https://connect.guiabolso.com.br") {
      let oauthcode = message.data
   }
}

Documentação da API

2. Obter Tokens