Metadata

Contexto

Na criação de simulações e propostas vindas de parceiros, é comum a necessidade de termos informações extras para identificação dos leads ou para envio de dados além dos obrigatórios. Por exemplo, caso o parceiro esteja realizando uma campanha de marketing ou teste A/B, que precise identificar a conversão destes grupos, o controle é feito manualmente, através da troca de arquivos Excel entre ele e a Creditas. Além da complexidade operacional, tal forma de tráfego de informações, muitas vezes sensíveis, pode ocasionar riscos à segurança da informação.

Metadados - “Campos Livres”

Para resolver a situação, foi criada a estrutura chamada de “Metadados”. Esta corresponde a um campo livre para, no momento de criação de simulações ou propostas, o parceiro tenha liberdade para enviar as informações que deseje. Tais dados serão armazenados pela Creditas e poderão ser analisados de forma mais simples.

Rotas da API com campo metadata

POST /offers
POST /proposals

Em ambas, o envio do campo é opcional.

Formato de Dados

Nas rotas acima, existe um campo chamado “metadata” que permite o envio de dados no formato JSON. A nomenclatura dos campos é livre, podendo receber desde elementos simples (chave + valor), como estruturas mais robustas (ver exemplos abaixo).

Informações sobre os campo

Response Body

Exemplo do objeto JSON

{
    "metadata": {
        "experiment": "teste",
        "channel": "web",
        "key": "value",
        "key_list": [
            0,
            1,
            2
        ]
    }
}

Exemplos de Payloads

Marcação de campanha de marketing que o lead está enquadrado

{
    "campaign": "carnaval-24"
}

Marcação de campanha com dados de CRM

{
    "campaign": "ferias-24",
    "baseCRM": [
        "group-teste-1",
        "segment-XPTO",
        "ABTest-A"
    ]
}

Boas práticas

Para simplificar a análise posterior dos dados enviados, é importante manter uma padronização de nomenclatura das informações enviadas. Por exemplo, caso queira enviar dados referentes a campanhas de marketing, uma sugestão é usar a chave com o nome “campanha” sempre que necessário.
Como boa prática, discuta com seu executivo de parcerias/ time Creditas quais dados serão enviados, qual a aplicação e afins. Assim, poderemos documentar no detalhe a origem e finalidade da informação e simplificar as consultas futuras.

Em caso de dúvidas sobre o uso do campo e/ou boas práticas, entre em contato com seu executivo parceiro!