Abrir o Connect

Para abrir o nosso produto você precisa antes de tudo das suas chaves de API. Tudo o que você precisa fazer é usar o nosso link de integração passando o seu CLIENT_ID e a CALLBACK_URL cadastrada e algumas informações do usuário como parâmetros na URL, assim como mostra o código abaixo.

COPIAR

https://connect.guiabolso.com.br/#/integracao
   ?clientId=CLIENT_ID
   &callbackURL=CALLBACK_URL
   &fallbackURL=https%3A%2F%2Fconnect.guiabolso.com.br%2F
   &userTrackingId=USER_TRACKING_ID
   &email=user@teste.com.br
   &cpf=12345678909
   &phone=11999999999

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, além disso toda URL (tanto a de callback quanto a de fallback) devem ser decodificadas em UTF-8.

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/`

Criptografia dos Dados

A fim de garantir o tráfego seguro dessas informações mesmo dentro do protocolo de comunicação TLS 1.3 e criptografia RSA 2048 bits, nós fornecemos uma API para que o link de integração seja criptografado com informações pessoais do usuário. Para gerar o link criptografado para cada usuário, envie um POST request para https://kasbah.guiabolso.com.br para a rota /partner/events/.

COPIAR

{
  "name": "gbconnect:url:generate",
  "version": 1,
  "id": UUID,
  "flowId": UUID,
  "payload": {
    "user": {
      "cpf": "12345678909",
      "email": "user@teste.com.br",
      "phone": "11999999999",
      "trackingId": USER_TRACKING_ID
    },
    "callbackURL": CALLBACK_URL,
    "fallbackURL": "https://connect.guiabolso.com.br/"
  },
  "identity": {
    "clientId": CLIENT_ID
  },
  "auth": {
    "clientSecret": CLIENT_SECRET
  },
  "metadata": {}
}

Você receberá uma resposta no seguinte formato, com a URL de integração para este usuário.

COPIAR

{
  "name": "gbconnect:url:generate:response",
  "version": 1,
  "id": UUID,
  "flowId": UUID,
  "auth": {},
  "identity": {},
  "payload": {
    "url": "https://connect.guiabolso.com.br/#/integracao?blob=AQICAHiT%2Bk%2FPDMzLasWvXiVYaTXLzKvx3T41Fl%2B5G6%2FP7kLi4gG9whJsF8amCIe1LrZZHt1XAAABujCCAbYGCSqGSIb3DQEHBqCCAacwggGjAgEAMIIBnAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAzub3YMnXQ%2FscxMnOQCARCAggFtzA4FU3frvNWjNMMjwslpPf%2FDKBKoylIlkCdxyHIzLvziPCC8%2BBIIA%2Bf%2BNUxnca1y2282uXu%2BmsBn%2FusWpqittUIZobpz73nf4WkF4oCfPzzmCINJZnS3L7BOeHLHEi0FFTJWOkERJoJJnI%2BkEc%2BZeSjc9vyXQEa0aauLBa98huRTD8MNBwSCF%2FcJ%2BZuTpeQU%2FXwNc4%2FdvgmYt0fDpSagefjbc7ftk84gRev%2Fz33HfhJsS53eA1CLmPLRebA1GmuK2nAJ2u%2F2OzOpg6mBu71fpET%2FImINMPnEeFePG5bfOfC6BDFEDCR4NGU%2FVZuqYfwOTXd%2BsfSUU5tUAtBUtrDPR5LFnSGY5EWIJHNLVoN2t4p5i7t3LW%2FkeI%2FqpDMPePHcFeatJ9H%2BA%2Fg%2Bb4aEv3qBMpLs7B3hhxM%2F8iMf8ZQ6ylNdGXJ19TOb%2BgukJCdeaw45MQ%2BU6g42d0r3veCDfZQ5iCDuuetsyQXA4TIVe"
  },
  "metadata": {}
}

Redirecionamento vs. Modal

Existem hoje 2 formas de abrir o Connect, a primeira redirecionando o usuário para o nosso ambiente e a segunda abrindo um Modal dentro da sua plataforma.

Modal

Você pode disponibilizar um botão na sua página que abra o modal do Connect (nós recomendamos que o tamanho do modal seja de 992 x 800). Neste caso, você também precisaria cadastrar um Listener para o evento de retorno onde receberá o código de autorização do usuário, como mostrado abaixo.

COPIAR

<button onclick="openGuiabolsoConnect()">Guiabolso Connect</button>
<script>
  function openGuiabolsoConnect() {
    window.open(INTEGRATION_URL, "gbConnectWindow", "width=992,height=800");
  }
</script>

COPIAR

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

Redirecionamento

De forma alternativa, você pode simplesmente redirecionar o usuário para o nosso ambiente. Isso quer dizer que quando o usuário terminar o fluxo 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 como query parameter.

COPIAR

https://minha-callback.com/?authCode=<AUTH_CODE>

Mas preste atenção, este código de autorização é válido por 60 minutos, isso significa que você tem 60 minutos para pedir autorização para nossa API em nome do usuário usando esse código.

Fluxo de Integração

2. Obter Token de Acesso