API Reference

Buscar transação

Com o identificador da transação é possível buscar o estado que ela se encontra: “Processing” e “Processed”. Após a conclusão do processamento o estado será “Processed” indicando que a exportação foi concluída, ficara disponível informações sobre o processamento como o total de itens processados, data de expiração dos arquivos e uma lista de arquivos no qual gerado pelo processamento.

Arquivos

Na finalização do processamento ficara disponível uma lista de arquivos com os dados processados em formato JSON, os dados ficarão separados em arquivos de até 500MB e os links de acesso ficarão disponível por 24 horas.

Os arquivos podem ser disponibilizados criptografados em formato AES, para descriptografar será necessário uma chave privada que foi disponibilizada no momento que foi gerada a apiKey

Estrutura dos dados

As informações processadas terão a seguinte estrutura:

[
  {
    "CustomerId": "Id do cliente",
    "PersonId": "Id da pessoa",
    "Profiles": [
	    // Lista de Profiles
    ]
  }
]

A lista contida em Profiles contem objetos com informações de acordo com o seu tipo:

  • PersonalProfile:
{
  "Id": "Id do perfil",
  "FirstName": "Primeiro nome",
  "LastName": "Ultimo nome",
  "Gender": "Gênero",
  "Birthday": "Data de aniversário",
  "LastVisit": "Ultimo acesso",
  "Type": "Tipo do perfil",
  "IPAddress": "Endereço IP",
  "Source": "Origem da informação",
  "Status": "Estado do perfil",
  "CreateDate": "Data de criação",
  "UpdateDate": "Data de atualização"
}
  • EmailProfile:
{
  "Id": "Id do perfil",
  "Email": "E-mail",
  "Type": "Tipo do perfil",
  "IPAddress": "Endereço IP",
  "Source": "Origem da informação",
  "Status": "Estado do perfil",
  "CreateDate": "Data de criação",
  "UpdateDate": "Data de atualização"
}
  • PhoneProfile:
{
  "Id": "Id do perfil",
  "Phone": "Telefone",
  "Type": "Tipo do perfil",
  "IPAddress": "Endereço IP",
  "Source": "Origem da informação",
  "Status": "Estado do perfil",
  "CreateDate": "Data de criação",
  "UpdateDate": "Data de atualização"
}
  • CpfProfile:
{
  "Id": "Id do perfil",
  "Cpf": "Cpf",
  "Type": "Tipo do perfil",
  "IPAddress": "Endereço IP",
  "Source": "Origem da informação",
  "Status": "Estado do perfil",
  "CreateDate": "Data de criação",
  "UpdateDate": "Data de atualização"
}
  • AppPushProfile:
{
  "Id": "Id do perfil",
  "AppPushId": "Id do AppPush",
  "Plataform": "Plataforma do AppPush (Android/IOS)",
  "Type": "Tipo do perfil",
  "IPAddress": "Endereço IP",
  "Source": "Origem da informação",
  "Status": "Estado do perfil",
  "CreateDate": "Data de criação",
  "UpdateDate": "Data de atualização"
}
  • BtgProfile:
{
  "Id": "Id do perfil",
  "CookieId": "Id do cookie",
  "Type": "Tipo do perfil",
  "IPAddress": "Endereço IP",
  "Source": "Origem da informação",
  "Status": "Estado do perfil",
  "CreateDate": "Data de criação",
  "UpdateDate": "Data de atualização"
}
  • CustomAttributesProfile:
{
  "Id": "Id do perfil",
  "CustomAttributes": {
    "attr1": {
      "Value": "Valor do atributos",
      "Type": "Tipagem do atributo (string/integer/float/boolean/datetime)",
      "CreateSource": "Origem da criação",
      "UpdateSource": "Origem da atualização",
      "CreateDate": "Data de criação",
      "UpdateDate": "Data de atualização"
    }
  },
  "Type": "Tipo do perfil",
  "IPAddress": "Endereço IP",
  "Source": "Origem da informação",
  "Status": "Estado do perfil",
  "CreateDate": "Data de criação",
  "UpdateDate": "Data de atualização"
}
  • ExternalProfile:
{
  "Id": "Id do perfil",
  "ExternalId": "Id externo",
  "ExternalType": "Tipo do id externo",
  "Type": "Tipo do perfil",
  "IPAddress": "Endereço IP",
  "Source": "Origem da informação",
  "Status": "Estado do perfil",
  "CreateDate": "Data de criação",
  "UpdateDate": "Data de atualização"
}
  • FacebookProfile:
{
  "Id": "Id do perfil",
  "FacebookId": "Id do facebook",
  "Type": "Tipo do perfil",
  "IPAddress": "Endereço IP",
  "Source": "Origem da informação",
  "Status": "Estado do perfil",
  "CreateDate": "Data de criação",
  "UpdateDate": "Data de atualização"
}
  • PushProfile:
{
  "Id": "Id do perfil",
  "Token": "Token",
  "Retry": "Tentativas de atualização do token",
  "LastRetryUpdate": "Data da atualização do token",
  "Type": "Tipo do perfil",
  "IPAddress": "Endereço IP",
  "Source": "Origem da informação",
  "Status": "Estado do perfil",
  "CreateDate": "Data de criação",
  "UpdateDate": "Data de atualização"
}
  • SmartLinkProfile:
{
  "Id": "Id do perfil",
  "SmartLinkId": "Id do SmartLink",
  "Type": "Tipo do perfil",
  "IPAddress": "Endereço IP",
  "Source": "Origem da informação",
  "Status": "Estado do perfil",
  "CreateDate": "Data de criação",
  "UpdateDate": "Data de atualização"
}
Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!