API de Clientes: Como Utilizar e Configurar
API de Clientes: Como Utilizar e Configurar
Esta API (sigla em inglês deApplication Programming Interface) permite a integração entre suas aplicações e a administração de clientes da Atom. Esta API permite:
Criar ou atualizar um cliente
Obter uma lista de clientes
Visualizar os dados de um cliente por meio do seu ID
Visualizar os dados de um cliente por meio do seu número de telefone
Endpoint: Create Client – Criar / Atualizar Cliente
Este serviço permite a criação ou atualização de um cliente na Atom.
Parâmetros
A seguir descrevemos os parâmetros que devem ser incluídos obrigatoriamente na requisição, e outros que podem ser adicionados opcionalmente:
| Nome do Parâmetro |
| Descrição |
| Tipo de Dado |
| Obrigatório |
| firstName |
| Nome do cliente |
| string |
| Sim |
| lastName |
| Sobrenome do cliente |
| string |
| Sim |
| phone |
| Número de telefone do cliente. Deve ser informado com o código do país, sem utilizar o sinal + |
| Correto: 50755667788 ✅ |
| Incorreto: +50555667788 ❌ |
| Incorreto: 55667788 ❌ |
| string |
| Sim |
| email |
| E-mail do cliente |
| string |
| Opcional |
| optionals |
| Parâmetros adicionais para realizar o mapeamento dos campos de informação associados ao cliente. Os valores devem ser enviados no formato{key: value} |
| object |
| Sim |
| tags |
| Etiquetas associadas ao cliente |
| string |
| Opcional |
A requisição para realizar a criação de um cliente utilizando a API da AtomChat é realizada da seguinte forma:
Tipo de Conexão
Acesso público pela Internet
Endpoint
Método
POST
Cabeçalhos
Corpo
Respostas
Cliente novo
Código:200
Token incorreto
Código:400
Não foi possível criar o cliente
Código:500
Não foi possível atualizar o cliente
Código:500
Não foi possível atualizar o cliente
Código:500
Endpoint: Client List – Obter lista de clientes
Este serviço permite obter uma lista de todos os clientes.
Parâmetros
A seguir explicamos os parâmetros que podem ser incluídos na requisição:
| Nome do Parâmetro |
| Descrição |
| Tipo de Dado |
| Obrigatório |
| page |
| Indicador da página da qual se deseja obter os registros. Default: 1 |
| string |
| Não. Padrão: 1 |
| size |
| Quantidade de registros a recuperar. Default: 10 |
| string |
| Não. Padrão: 10 |
| tags |
| Etiquetas para filtragem |
| string |
| Não |
| sort |
| Ordem dos resultados. Valores aceitos:asc |
| desc. Default: asc |
| string |
Endpoint
Método
GET
Cabeçalhos
Respostas
Listar clientes
Código:200
Não há lista de clientes
Código:500
Token incorreto
Código:400
Exemplo de estrutura JSON
Endpoint: Get Client by ID – Ver dados de um cliente
Este serviço permite obter os detalhes de um cliente específico por meio do seu ID.
Cliente recuperado
Código:200
Cliente inexistente
Código:404
Token incorreto
Código:400
Erro genérico
Código:500
Endpoint: Get Client by Phone – Ver dados de um cliente
Este serviço permite obter os detalhes de um cliente específico por meio do seu número de telefone.
Lasrespostas, códigos e exemplos JSON são idênticosao endpoint anterior (Get Client by ID), incluindo:
Cliente recuperado –200
Cliente inexistente –404
Token incorreto –400
Erro genérico –500