API SenseConnect: Boas práticas para a integração de Campos Customizados via API

Uma maneira de integrar campos customizados no SenseData é por meio da nossa API, o SenseConnect. Você pode acessar a documentação completa do SenseConnect clicando aqui.

Para a integração de Campos Customizados via API são necessárias algumas boas práticas para que os dados subam de maneira correta para a plataforma.

Uma delas é o campo utilizado na API. Ele precisa ser igual ao nome interno deste campo customizado no SenseData.

Por exemplo, o campo customizado com nome ‘Plan’. Apesar do nome do campo estar como ‘Plan’, o seu nome interno é ‘plan_2’. Portanto, o nome a ser utilizado na API deve ser ‘plan_2’ também.

Outra observação que deve ser feita é quando se faz uso do “CamelCase”. Ou seja, quando se utiliza uma letra maiúscula como separador das palavras. O ideal nesses casos é que se utilize o underline para essa separação, pois os nomes dos campos customizados são sempre com letras minúsculas.

Quando se utiliza um Json dentro do custom field, o valor a ser mostrado dentro desse campo será o de todo o Json. Caso deseje que seja mostrado somente o valor de cada campo dentro do Json, o ideal é que seja feito um novo custom field para cada um desses campos.

Dependendo do tipo do campo a ser utilizado, alguns pontos devem ser levados em consideração. Campos do tipo ‘Data’ não podem ser uma string vazia ' ', e com isso, devem ser preenchidos com null ou conter uma data válida no formato ISO, '2020-12-31'.

Os campos do tipo ‘Checklist’ também não podem ser uma string vazia ' ', e com isso, devem ser preenchidos com null, array vazio [ ] ou array preenchido [{valor1},{valor2}].

Para os campos do tipo ‘Checklist’ e ‘Select’ é recomendado que se preencha os valores que eles terão nas opções quando o campo for criado no SenseData.

No artigo “Utilizando Campos Customizados no SenseData”, você encontra informações de como criar esses campos customizados na plataforma.

Caso possua dúvidas sobre esses pontos basta contactar o nosso suporte através do email: suporte@sensedata.com.br