Referência de API

Cadastrar um novo cliente

post
https://register-hml.apifrenet.com.br/v1/partner/register

A criação de novo usuário, quando executada com sucesso pelo Frenet, retornará um token este token é exigido pela API de cotação do Frenet, por este motivo o parceiro deverá salva-lo e enviar nas chamadas do cotador Frenet.

Observe que algumas informações precisam ser solicitadas ao suporte do Frenet.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Nome completo da pessoa física ou a Razão Social da pessoa Jurídica, o campo é utilizado para exibição do nome do cliente dentro do painel administrativo do Frenet

string
required

E-mail do cliente, este campo é o mais importante de toda a API, será usado como chave para autenticação no painel administrativo e para os comunicados enviados pelo Frenet

string

Senha definida para o cliente, será a senha para autenticação no painel administrativo do Frenet, quando não informada será gerada uma senha aleatória e esta será enviada por e-mail ao cliente somente se o campo SendEmail for igual a true

string

CPF da pessoa física ou CNPJ da pessoa jurídica

integer

Identifica o tipo do cliente, por enquanto aceita apenas o valor 1 (Clientes)

string

Pessoa física ou jurídica, onde F identifica uma pessoa física e J uma pessoa jurídica

string

Nome completo da pessoa física ou a Razão Social da pessoa Jurídica, o campo é utilizado na geração de boletos e comunicados via e-mail

string

Inscrição estadual da pessoa jurídica, não se aplica para pessoa fisica e se informado será ignorado

string

Url da loja/site da pessoa ou empresa

integer

CEP da empresa ou pessoa física, este campo é usado como CEP de origem no momento da cotação de Frete

string

Cidade da empresa ou residência da pessoa física, este campo é usado na geração das faturas de cobrança

string

Código abreviado do Estado da empresa ou residência da pessoa física, este campo é usado na geração das faturas de cobrança

string

Logradouro da empresa ou residência da pessoa física, este campo é usado na geração das faturas de cobrança

string

Número do logradouro da empresa ou residência da pessoa física, este campo é usado na geração das faturas de cobrança

string

Complemento do endereço da empresa ou residência da pessoa física, este campo é usado na geração das faturas de cobrança

string

Bairro da empresa ou residência da pessoa física, este campo é usado na geração das faturas de cobrança

int64

Número de telefone da empresa ou residência da pessoa fisica, usado nos contatos for telefone

string

Nome do responsável pela empresa, e para a pessoa fisica poderá ser um segundo ponto de contato

string

E-mail do responsável pela empresa, e para a pessoa fisica poderá ser um segundo ponto de contato

string

CPF do responsável pela empresa e para a pessoa fisica poderá ser uo CPF de um segundo ponto de contato

boolean

Flag informando se um e-mail de boas vindas com os dados para a realização do primeiro acesso ao painel administrativo do Frenet

boolean

Flag informando se após a chamada da API um e-mail para confirmação/validação será enviado para o cliente, é necessário para confirmação do e-mail informado no campo E-mail

integer

Código da plataforma, o valor para este campo será informado pela equipe de integração do Frenet

string

Nome da plataforma, o valor para este campo será informado pela equipe de integração do Frenet

integer

Código da agência, o valor para este campo será informado pela equipe de integração do Frenet

string

Nome da agência, o valor para este campo será informado pela equipe de integração do Frenet

integer

Código do plano, o valor para este campo será informado pela equipe de integração do Frenet

integer

Código promocional, o valor para este campo será informado pela equipe de integração do Frenet

string

Código do contrato do cliente na transportadora, valores permitidos são aqueles retornados na API http://api.frenet.com.br/v1/options/{CarrierCode}

string

Código da transportadora no Frenet, valores permitidos: COR, JAD

integer

Tempo máximo de resposta da API de cotação.

integer

Tempo máximo de resposta da API de cotação para os marketplaces.

string

Versão utilizada para criação da conta. valores permitidos: Wizard, SinglePage

string

Dispositivo utilizado para criação da conta.

string

Nome da plataforma parceira que intermediou a criação da conta.

string

Código da campanha que intermediou a criação da conta.

string

Código do conteudo que intermediou a criação da conta.

string

Código da midia intermediou a criação da conta.

string

Termo de busca.

string

nome da landingPage

string

Código da campanha que intermediou a criação da conta.

string

Código da campanha que intermediou a criação da conta.

string

Código do cliente na plataforma que utiliza.

string

Origem do cadastro.

string

Teste de origem de cadastro do site publico

string

Id da loja na plataforma.

boolean

Email confirmado na plataforma.

boolean

Telefone confirmado na plataforma.

boolean

Plano pago na plataforma.

string

Identificador do canal associado.

string

Primeiro nível de detalhamento do canal.

string

Segundo nível de detalhamento do canal.

string

Terceiro nível de detalhamento do canal.

string

Quarto nível de detalhamento do canal.

string

Identificador da landing page associada.

string

Grupo de landing pages associado.

CustomFields
array of objects

Retorna a lista de campos dinâmicos.

CustomFields
Headers
string

e.g. application/json

string
required

e.g. (token de parceiro)

Responses

Updated about 1 year ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago