4. Obtendo Dados do Usuário

Depois de requisitar autorização (passo 3 anterior) você já pode obter informações do usuário de acordo com as soluções da nossa prateleira. Cada um dos eventos expostos na nossa API busca dados financeiros específicos.

Temos atualmente 4 soluções financeiras: credit, identification, segmentation e financial. A solução de identificação financeira busca dados referentes as contas bancárias conectadas do usuário, a solução de crédito uma estimativa do dia de pagamento do usuário e assim por diante.

API: Variáveis Financeiras

Para obter os dados financeiros do usuário diretamente na API do Guiabolso, basta enviar uma requisição POST passando o seguinte body em JSON para a rota /gbConnect/events/ da nossa API kasbah.guiabolso.com.br.

Note que a solução financeira é o próprio nome do evento. Se você quisesse buscar dados financeiros bastaria chamar gbconnect:financial:variables.

{
  "name": "gbconnect:credit:variables",
  "version": 1,
  "id": "916a91c5-5ac0-43aa-a48c-7d928f0850c2",
  "flowId": "04028edb-87b1-43cf-91c9-52871a1f5cb3",
  "payload": {},
  "identity": {
    "clientId": "CLIENT_ID"
  },
  "auth": {
    "clientSecret": "CLIENT_SECRET",
    "accessToken": "ACCESS_TOKEN"
  },
  "metadata": {}
}

id e o flowId devem ser identificadores UUID válidos. Eles são usados respecitvamente para identicação do evento e para rastreabilidade dentro do Guiabolso

accessToken é o token de acesso gerado no passo 3 desta integração passado em formato de string na requisição

clientId é o identificador da sua credencial e o clientSecret sua senha.

A seguir mostramos um exemplo de resposta com as respectivas informações financeiras requisitadas na resposta HTTP. Temos muitas variáveis e informações financeiras na nossa prateleira, para fins de demonstração vamos mostrar apenas um exemplo de resposta com apenas 1 dessas variáveis.

{
  "name": "gbconnect:credit:variables:response",
  "version": 1,
  "id": "916a91c5-5ac0-43aa-a48c-7d928f0850c2",
  "flowId": "04028edb-87b1-43cf-91c9-52871a1f5cb3",
  "auth": {},
  "identity": {},
  "payload": {
    "context": "GBCONNECT",
    "created": "2020-06-18T21:35:38-03:00",
    "variables": [
      {
        "key": "GUIABOLSO.TRANSACTIONS.SALARY_PAYDAY.V2",
        "value": 5,
        "type": "INT64"
      }
    ]
  },
  "metadata": {}
}

A variável GUIABOLSO.TRANSACTIONS.SALARY_PAYDAY.V2 retorna a estimativa de dia do pagamento do salário do usuário.

Connector: Todas as Variáveis Financeiras

Se você estiver usando o Connector, e quiser todos os dados de uma só vez, basta usar o evento agregador gbconnect:variables que está configurado no arquivo datapackage.yml do próprio Connector.

Basta enviar uma requisição POST para a rota /gbConnect/events/ do Connector com o seguinte body em JSON.

{
  "name": "gbconnect:variables",
  "version": 1,
  "id": "916a91c5-5ac0-43aa-a48c-7d928f0850c2",
  "flowId": "04028edb-87b1-43cf-91c9-52871a1f5cb3",
  "payload": {},
  "identity": {
    "userId": "USER_ID"
  },
  "auth": {},
  "metadata": {}
}

id e o flowId devem ser identificadores UUID válidos. Eles são usados respecitvamente para identicação do evento e para rastreabilidade dentro do Guiabolso

userId é o identificador único do usuário na sua plataforma em formato string

Se o evento acima for bem sucedido, você receberá a seguinte resposta.

A variável GUIABOLSO.USER.ACCOUNTS.COUNT.V1 retorna o número de contas conectadas pelo usuário. No nosso exemplo o usuário recebe seu salário todo dia 5 do mês.

{
  "name": "gbconnect:variables:response",
  "version": 1,
  "id": "916a91c5-5ac0-43aa-a48c-7d928f0850c2",
  "flowId": "04028edb-87b1-43cf-91c9-52871a1f5cb3",
  "payload": {
    "variables": [
      {
        "key": "GUIABOLSO.USER.ACCOUNTS.COUNT.V1",
        "value": 2,
        "type": "int64"
      },
      {
        "key": "GUIABOLSO.TRANSACTIONS.SALARY_PAYDAY.V2",
        "value": 5,
        "type": "int64"
      }
    ]
  },
  "identity": {},
  "auth": {},
  "metadata": {}
}