Utilize nossa API de Templates no Atom.

Esta API (Interface de Programação de Aplicações) permite a integração direta entre as suas aplicações e o módulo de administração de clientes da Atom. Através dela, você poderá executar as seguintes ações:

Criar ou atualizar um cliente.
Obter uma lista paginada de clientes.
Consultar os dados de um cliente através do seu ID.
Consultar os dados de um cliente através do seu número de telefone.

Abaixo, detalhamos a estrutura, os parâmetros e as respostas de cada endpoint.

1️⃣ Endpoint: Criar ou Atualizar Cliente (Create / Update)

Este serviço permite a criação de um novo cliente ou a atualização dos dados de um cliente já existente na Atom.

Parâmetros

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.	string	Sim
`email`	E-mail do cliente	string	Não
`optionals`	Parâmetros adicionais para o mapeamento de campos de informação. Valores no formato `{key: value}`	object	Sim
`tags`	Etiquetas (tags) de segmentação para o cliente	array (string)	Não

⚠️ Importante sobre o formato do telefone (phone):

Você deve inserir o código do país sem utilizar o sinal +, espaços ou traços.

✅ Correto: 50755667788
❌ Incorreto: +50555667788
❌ Incorreto: 55667788

Detalhes da Requisição

Endpoint: https://us-central1-atomchat-io.cloudfunctions.net/clients
Método: POST
Cabeçalhos (Headers):
- Content-type: application/json; charset=utf-8
- Authorization: Bearer [seu_token_publico]

Corpo da Requisição (Body)

JSON

{  
"firstName": "nome_do_cliente",
  "lastName": "sobrenome_do_cliente",
  "phone": "numero_de_telefone",
  "email": "email_do_cliente",
  "optionals": {     "option1": "valor",
     "option2": "valor"   
},
  "tags": ["tag 1","tag 2"] 
}

Respostas Esperadas

Cenário	Código HTTP	Corpo da Resposta
Novo cliente criado	200	`{"client": "clientID"}`
Token incorreto / Formato inválido	400	`{"context": {"key": "Authorization", "label": "headers.authorization", "value": "Bearer"}, "message": "Cannot find a channel...", "type": "Bad format"}`
Erro ao criar / atualizar	500	`{"message": "Cannot perform the creation/update of the client at [Date]"}`

2️⃣ Endpoint: Obter lista de clientes (Client list)

Este serviço permite obter uma lista geral de todos os clientes cadastrados na sua conta, com opções de paginação e filtros.

Parâmetros de URL (Query Params)

Parámetro	Descrição	Tipo de Dado	Obrigatório
`page`	Número da página que deseja obter. (Padrão: 1)	string	Não
`size`	Quantidade de registros por página. (Padrão: 10)	string	Não
`tags`	Etiquetas específicas para filtrar resultados.	string	Não
`sort`	Ordem dos resultados (`asc` ou `desc`). (Padrão: `asc`)	string	Não

Detalhes da Requisição

Endpoint: https://us-central1-atomchat-io.cloudfunctions.net/clients?page={string}&size={string}&sort={string}
Método: GET
Cabeçalhos (Headers):
- Content-type: application/json; charset=utf-8
- Authorization: Bearer [seu_token_publico]

Respostas Esperadas

Cenário	Código HTTP	Mensagem / Estrutura
Listagem bem-sucedida	200	Retorna o objeto JSON com a paginação e o array de `items`. (Ver exemplo abaixo)
Token incorreto	400	Erro de formato de autorização.
Erro genérico	500	`{"message": "Something went wrong while the operation was being performed"}`

Exemplo de Resposta Bem-sucedida (200 OK)

JSON

{
"page": 1,
"length": 1,     
"items": [
       {             
"id": "V2EON8A6SPwC2VudgFbp",
"firstName": "Silvio Nicole",
"lastName": "Carballo",
"email": null,
"optionals": {
                 "Monto": "21",
                 "Referido1": "123123"
              },
             "phone": "50588541975",
             "tags": [null, "test-label-2sss", null],             
"user": {                 
"id": "qa-sinsa-ni-qchsjn",                 
"name": "Develop - Sinsa QA"             
},             
"updatedAt": "2022-04-22T13:26:31.139Z",
             "createdAt": "2022-08-15T22:18:05.683Z"     {
    "page": 1,
    "length": 1,
    "items": [
        {
            "id": "V2EON8A6SPwC2VudgFbp",
            "firstName": "Silvio Nicole",
            "lastName": "Carballo",
            "email": null,
            "optionals": {
                "Monto": "21",
                "Referido1": "123123"
            },
            "phone": "50588541975",
            "tags": [null, "test-label-2sss", null],
            "user": {
                "id": "qa-sinsa-ni-qchsjn",
                "name": "Develop - Sinsa QA"
            },
            "updatedAt": "2022-04-22T13:26:31.139Z",
            "createdAt": "2022-08-15T22:18:05.683Z"
        }
    ]
}

- Content-type: application/json; charset=utf-8
- Authorization: Bearer [seu_token_publico]

Respostas Esperadas

Cenário	Código HTTP	Mensagem / Estrutura
Cliente recuperado	200	Retorna o objeto JSON com os dados do cliente.
Token incorreto	400	Erro de formato de autorização.
Cliente inexistente	404	`{"message": "Cannot find the client..."}`
Erro genérico	500	`{"message": "Something went wrong..."}`

4️⃣ Endpoint: Ver dados de um cliente por Telefone (Get by Phone)

Este serviço permite obter os detalhes de um cliente específico realizando a busca diretamente pelo seu número de telefone cadastrado.

Detalhes da Requisição

Endpoint: https://us-central1-atomchat-io.cloudfunctions.net/clients?phone={phoneNumber}
Método: GET
Cabeçalhos (Headers):
- Content-type: application/json; charset=utf-8
- Authorization: Bearer [seu_token_publico]

Respostas Esperadas

Cenário	Código HTTP	Mensagem / Estrutura
Cliente recuperado	200	Retorna o objeto JSON com os dados do cliente.
Token incorreto	400	Erro de formato de autorização.
Cliente inexistente	404	`{"message": "Cannot find the client..."}`
Erro genérico	500	`{"message": "Something went wrong..."}`

Exemplo de Resposta Bem-sucedida (Endpoints 3 e 4){

 "id": "V2EON8A6SPwC2VudgFbp",
    "firstName": "Silvio Nicole",
    "lastName": "Carballo",
    "email": null,
    "optionals": {
        "Monto": "21",
        "Referido1": "123123",
        "texto 2": "asesor"
    },
    "phone": "50588541975",
    "tags": [null, "test-label-2sss", null],
    "user": {
        "id": "qa-sinsa-ni-qchsjn",
        "name": "Develop - Sinsa QA"
    },
    "updatedAt": "2022-04-22T13:26:31.139Z",
    "createdAt": "2022-08-15T22:18:05.683Z"
}

Conecte os seus sistemas como um especialista! 🚀

Com a API de Clientes, você tem o poder de sincronizar as informações do seu banco de dados em tempo real entre a Atom e as suas plataformas internas. Certifique-se de configurar corretamente os seus tokens e parâmetros, e leve a gestão dos seus contatos para o próximo nível. ✅