Configurar API externa à Integração com cliente
- 27/05/2024
Uma das funcionalidades da plataforma é se integrar com uma API externa para buscar dados cadastrais de clientes, o que otimiza o processo de atendimento ao fornecer o maior número de informações possível sobre o cliente.
Nessa integração, a empresa (cliente Smartspace) fornece os dados através de uma API que será lida pela plataforma na tela Integração com cliente (Administração > Configurações Gerais > Integração com cliente > (botão) +Novo). Além de buscar as informações fornecidas pela API, também pode editá-las no sistema externo sem precisar acessá-lo.
Pré-requisitos
As informações necessárias devem ser especificadas utilizando um formato JSON e em protocolo HTTPS.
O path para chamadas deve ser disponibilizado pela empresa incluindo o de autenticação.
Autenticação
A API deve ter um dos seguintes tipos de autenticação:
- Basic Auth: Autenticação básica no formato usuário e senha.
- OAuth2: Protocolo de autenticação que fornece um access token.
Configuração
É possível detalhar informações sobre o cliente, como: nome, código, data de nascimento, email, telefone, estado civil, RG, CPF, CNPJ, gênero, e outros dados que sejam relevantes para o usuário.
Para que a plataforma o possa ler essas informações os campos devem estar em um array com propriedades de nível um. Se existirem hierarquias mais extensas não é possível resgatar os dados corretamente.
Se for necessário descrever o endereço do cliente por exemplo, os atributos devem ser inseridos na seguinte estrutura:
"enderecoLogradouro": "string",
"enderecoNumero": "string",
"enderecoComplemento": "string",
"enderecoBairro": "string",
"enderecoCidade": "string",
"enderecoEstado": "string",
"enderecoCep": "string",
"enderecoPontoReferencia": "string"
Exemplo de payload com vários campos, incluindo os obrigatórios:
[
{
"nome": "JOÃO DA SILVA”,
“cpf”: “00000000000”,
“data_nascimen”: “00/00/0000”,
“crm”: "000000",
“email”: “email@email.com”,
“telefone”: “00000000000”,
“telefone_2”: “00000000000”,
“tipo_prestador”: “PESSOA FÍSICA”,
“especialidade”: “DERMATOLOGISTA”,
“endereco_logradouro”: “RUA ENDEREÇO, 100”,
“endereco_complemento”: “1 A”,
“endereco_cep”: “00000000”,
“endereco_bairro” “BAIRRO ENDEREÇO”,
“endereco_cidade”: “JOAO PESSOA”,
"endereco_estado”: “PB”
"pos_graduacao": "SIM”,
“ativo”: “TRUE”
}
]
