API Reference

Buscar informações da 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:

{
  "AudienceId": "Id da audiência",
  "AudienceName": "Nomde da audiência",
  "CustomerId": "Id do cliente",
  "Profiles": [
    {
      "PersonId": "Id da pessoa",
      "FirstName": "Primeiro nome",
      "LastName": "Ultimo nome",
      "Gender": "Gênero",
      "Birthday": "Data de aniversário",
      "Email": "E-mail",
      "CPF": "CPF",
      "Phone": "Telefone",
      "AppPushId": "Id do AppPush",
      "OrigemInsercaoBase": "Origem da informação",
      "DataInsercaoBase": "Data de inserção"
    }
  ]
}
Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!