Buscar Dados do Usuário

Temos atualmente 4 soluções financeiras expostas na nossa API: solução de crédito, de identificação, de segmentação e solução financeira. Se quiser saber mais detalhes sobre quais informações existem em cada uma dessas soluções, entre em contato por email.

Como chamar a API pra buscar Dados Financeiros?

Envie um POST request para https://kasbah.guiabolso.com.br para a rota /gbConnect/events/.

Solução Financeira	Nome do evento
`crédito`	gbconnect:credit:variables
`identificação`	gbconnect:identification:variables
`segmentação`	gbconnect:segmentation:variables
`financial`	gbconnect:financial:variables

COPIAR

{
  "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": {}
}

Campo	Descrição
`id`	É um identificador único, pode ser um UUID gerado de forma aleatória, que identifica esse evento específico. Você pode passar qualquer identificador aqui contanto que ele seja único e não seja sensível.
`flowId`	É um identificador único, pode ser um UUID gerado de forma aleatória. Diz respeito a como o Guiabolso rastreia as requisições dentro da sua plataforma, você pode passar qualquer identificador aqui contanto que ele seja único e não seja sensível.
`clientId`	ID da sua chave de API que fornecemos pra você
`clientSecret`	Secret da sua chave de API que fornecemos pra você
`accessToken`	Token de acesso do usuário válido por 30 minutos

Exemplo de uma resposta bem sucedida da nossa API, temos várias informações financeiras na nossa prateleira dentro de cada solução, para fins de demonstração vamos mostrar apenas um exemplo de resposta com apenas 1 dessas variáveis.

Variável Financeira	Descrição
`GUIABOLSO.TRANSACTIONS.SALARY_PAYDAY.V2`	Estimativa de dia do pagamento do salário do usuário

COPIAR

{
  "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": {}
}

E o Middleware como ajuda?

Nós criamos um Middleware pra ajudar na integração e na agregação de todas as nossas soluções financeiras. Se você quiser saber mais detalhes sobre os benefícios de usar o Guiabolso Connector basta seguir e ler as próximas seções. Mas note que o Middleware deve ser instalado na sua infraestrutura de Cloud (hoje suportamos tanto a AWS quanto o GCP).

Envie um POST request para o Connector para a rota /gbConnect/events/ passando o ID do usuário da sua plataforma no qual quer buscar dados financeiros. O próprio Middleware vai gerenciar o mapeamento das informações financeiras por ID de usuário e retornar todas as soluções agregadas em um único evento.

COPIAR

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

Campo	Descrição
`id`	É um identificador único, pode ser um UUID gerado de forma aleatória, que identifica esse evento específico. Você pode passar qualquer identificador aqui contanto que ele seja único e não seja sensível.
`flowId`	É um identificador único, pode ser um UUID gerado de forma aleatória. Diz respeito a como o Guiabolso rastreia as requisições dentro da sua plataforma, você pode passar qualquer identificador aqui contanto que ele seja único e não seja sensível.
`userId`	ID do seu usuário na sua plataforma em formato string

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

COPIAR

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

2. Obter Tokens

O que é o Connector