Configuração de Dados no Connector

O Connector possui a capacidade de configurar como e quando os dados serão buscados na API do Guiabolso. É possível definir novos eventos que agreguem dados buscados na API e definir diferentes níveis de cache de forma opcional. Se você não conhece o termo evento, leia no menu do lado esquerdo como nossa API funciona.

Pacote de Dados

Crie um novo arquivo chamado datapackage.yml com as configurações abaixo e deixe-o na mesma pasta que o arquivo do Connector está salvo. O Connector já possui uma configuração padrão embutida mas o ideal é que você possa sobrescrevê-la através desse arquivo.

#Pacote de dados para agregação de eventos
dataPackages:
  - publish:
      type: EVENT
      name: gbconnect:variables
      version: 1
    sources:
      - statusKey: GBCONNECT.IDENTIFICATION.VARIABLES.STATUS
        eventName: gbconnect:identification:variables
        eventVersion: 1
      - statusKey: GBCONNECT.CREDIT.VARIABLES.STATUS
        eventName: gbconnect:credit:variables
        eventVersion: 1
      - statusKey: GBCONNECT.SEGMENTATION.VARIABLES.STATUS
        eventName: gbconnect:segmentation:variables
        eventVersion: 1
      - statusKey: GBCONNECT.FINANCIAL.VARIABLES.STATUS
        eventName: gbconnect:financial:variables
        eventVersion: 1
#Configuração de cache de dados
dataCaches:
  - eventName: gbconnect:variables
    eventVersion: '*'
    duration: 7 days
    cacheUsagePolicy: ALWAYS

A palavra-chave publish define um evento agregador "gbconnect:variables" na versão 1. Esse evento será o resultado da execução de todos os eventos definidos dentro da palavra-chave sources. Ou seja, ele retornará todas as variáveis financeiras do usuário no que diz respeitos às nossas soluções: identificação, perfil financeiro, crédito e segmentação.

Porque isso é importante? Isso é importante para que você não precise gerenciar cada requisição em separado, basta chamar o evento agregador publicado e o próprio Connector mescla o resultado de todos os outros para você.

Cache de Dados

No próprio arquivo datapackage.yml é possível também definir uma política de cache a ser aplicada para os eventos. O uso de cache de dados não é obrigatório mas pode servir de proteção contra possíveis instabilidades na plataforma e para minimizar custos.

A palavra-chage dataCaches é usada para definir cache para os eventos. No nosso exemplo acima, definimos um cache de 7 dias para o evento "gbconnect:variables". O Connector só fará a requisição para um mesmo usuário se os 7 dias da primeira requisição já tiver passado.

O Connector suporta as seguintes políticas de cache:

• cacheDuration: [day, days, month, months, minute, minutes, min, second, seconds, s]
• cacheUsagePolicy: [NEVER, ONLY_ON_FAILURES, ALWAYS]

Considerações Finais

Apenas para fins de informação, isso é o que acontecerá quando você chamar o evento agregador que acabou de criar. Segue abaixo um exemplo de requisição bem sucedida para o evento gbconnect:variables. As informações financeiras do usuário sempre virão dentro do objeto payload em formato de variáveis com nome, valor e tipo.

{
  "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"
      }
    ]
  },
  "auth": {},
  "metadata": {}
}