Requisitando Credenciais de Acesso
O primeiro passo para a realização do envio de dados é possuir um client_id e client_secret. O mesmo pode ser utilizado tanto para o ambiente de produção quanto para o ambiente de homologação.
Realizando a requisição
Para o envio de dados é necessária a seleção de um endpoint adequado ao dado a ser enviado. Ex: Para dados de indivíduos o endpoint é “individual”.
Utilizar sempre o ambiente de Homologação para testes (hml) |
curl --request POST \ --url https://hml-mule-experience.br-s1.cloudhub.io/cdp/individual/v1 \ --header 'Content-Type: application/json' \ --header 'client_id: 86efa688f38f472ab6a2FDS07ca5a87e1c' \ --header 'client_secret: C52f5318aC7D4c228e3EDSDFS0bcA2FEDE' \ --data '{ "Address": null, "B2B": null, "B2C": "1", "Birthdate": null, "City": null, "CNPJ": null, "Country": null, "CPF": null, "DDI": null, "District": null, "DocumentType":"CPF", "Email":"teste.teste@teste.com", "ERPKey":null, "FirstName":"TestFirstNome", "Gender":null, "LastName":"TestLastName", "Message":null, "OptInEmail":"1", "OptInSms":"1", "PhoneNumber":null, "Postalcode":null, "ProductCategory":null, "Profession":null, "Source":null, "State":null, "RegistrationDate":"2024-04-01T12:12:12", "Language": "PT-br" }'
Dados Para Envio
Endpoint Individual:
FirstName (obrigatório): Inclua apenas a primeira parte do nome da pessoa.
LastName (obrigatório): Forneça a parte restante do nome, excluindo o FirstName.
Gender: Envie “M” para Masculino, “F” para Feminino ou “O” para Outro;
Address: Informe o endereço da pessoa.
Postalcode: Insira o CEP, incluindo a máscara no formato, como por exemplo “95185-000”.
City: Indique o nome da cidade da pessoa.
District: Forneça o nome do bairro.
State: Indique o código do estado, como por exemplo “RS”.
CPF: Insira o CPF da pessoa sem utilizar máscaras, por exemplo “01234567891”.
CNPJ: Insira o CNPJ da pessoa sem utilizar máscaras, por exemplo “0123456789123”.
DocumentType(obrigatório): Se o campo CPF for preenchido, envie a string “CPF”; caso o campo CNPJ seja preenchido, envie a string “CNPJ”.
Country: Indique o código do país correspondente, como por exemplo “BR”.
Email (obrigatório): Insira o endereço de email da pessoa.
PhoneNumber: Insira o número de telefone, sem usar máscaras, e inclua o DDI concatenado à frente, por exemplo “5551999999999”.
RegistrationDate (obrigatório): Insira a data e hora de preenchimento do cadastro(UTC), utilizando o formato “yyyy-MM-ddThh:mm:ss”.
Birthdate: Forneça a data de nascimento da pessoa no formato de data.
Profession: Indique o nome da profissão da pessoa.
B2B: Utilize “1” para indicar que o preenchimento foi feito por um cliente B2B.
B2C: Utilize “1” para indicar que o preenchimento foi feito por um cliente B2C.
OptInEmail (obrigatório): Utilize “1” se a pessoa aceitar receber envios de email.
OptInSms (obrigatório): Utilize “1” se a pessoa aceitar receber envios de SMS.
Source (obrigatório): Forneça o nome da entidade que está enviando os dados, bem como a descrição do formulário enviado, por exemplo “Huia – Formulário Newsletter”.
DDI: DDI do PhoneNumber(quando não enviado no PhoneNumber).
Message: Insira a descrição do registro enviado.
ProductCategory: Insira a categoria do produto.
Language: Linguagem do usuário, segundo padrão ISO 3166. Ex: “pt-BR”
Endpoint WhereToBuy:
StoreName: Nome da Loja a qual foi feito o redirecionamento
StoreLink: Link da Loja a qual o produto foi direcionado
SKU: SKU do Produto
ProductPrice: Valor do Produto
ProductLink: Link do Produto
RegistrationDate(obrigatório): Insira a data e hora de preenchimento do cadastro(UTC), utilizando o formato “yyyy-MM-ddThh:mm:ss”.
Endpoint IndividualGroupCourses:
CPF: CPF do Inidividuo cadastrado no curso(Sem Máscara)
RegistrationDate(obrigatório): Insira a data e hora de preenchimento do cadastro(UTC), utilizando o formato “yyyy-MM-ddThh:mm:ss”.
Source: Descrição do site de origem do registro
GroupName: Nome do Grupo(Grupo do Curso)