Como Criar um Cliente via API

Neste tutorial, você vai cadastrar um cliente na plataforma usando a API REST do Meu Atendimento Virtual. O processo consiste em montar a requisição com os dados do cliente e enviá-la ao endpoint de criação. O cliente criado recebe uma client_key exclusiva, que pode ser usada posteriormente para associá-lo a tickets de atendimento. Para consultar a referência completa dos endpoints disponíveis, acesse a documentação oficial da API.

I – Definindo os dados do cliente

A requisição aceita um JSON no corpo com os seguintes campos:

{
  "name": "João Silva",
  "email": "joao@example.com",
  "phone": "11999999999",
  "cpf": "123.456.789-00",
  "profession": "Engenheiro",
  "birthday": "1990-05-15",
  "place_of_birth": "São Paulo"
}

O único campo obrigatório é name. Os demais são opcionais:

• name: nome completo do cliente. Máximo de 200 caracteres.
• email: endereço de e-mail do cliente.
• phone: telefone de contato. Máximo de 15 caracteres.
• cpf: CPF do cliente.
• profession: profissão. Máximo de 100 caracteres.
• birthday: data de nascimento no formato AAAA-MM-DD (ex.: 1990-05-15).
• place_of_birth: naturalidade. Máximo de 100 caracteres.

II – Enviando a requisição

Envie uma requisição HTTP POST para:

POST https://painel.meuatendimentovirtual.com.br/api/v1/clientes/

Configure os seguintes cabeçalhos, usando a chave de API disponível nas configurações da plataforma:

• accept: application/json
• Authorization: Bearer <sua-chave-de-api>
• Content-Type: application/json

Exemplo com cURL:

curl -X POST https://painel.meuatendimentovirtual.com.br/api/v1/clientes/ \
-H "accept: application/json" \
-H "Authorization: Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999" \
-H "Content-Type: application/json" \
-d '{
  "name": "João Silva",
  "email": "joao@example.com",
  "phone": "11999999999",
  "cpf": "123.456.789-00",
  "profession": "Engenheiro",
  "birthday": "1990-05-15",
  "place_of_birth": "São Paulo"
}'

Exemplo em Python:

import requests

url = "https://painel.meuatendimentovirtual.com.br/api/v1/clientes/"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999",
    "Content-Type": "application/json"
}
data = {
    "name": "João Silva",
    "email": "joao@example.com",
    "phone": "11999999999",
    "cpf": "123.456.789-00",
    "profession": "Engenheiro",
    "birthday": "1990-05-15",
    "place_of_birth": "São Paulo"
}

response = requests.post(url, json=data, headers=headers)
print(response.status_code)
print(response.json())

III – Verificando a resposta

Uma criação bem-sucedida retorna o status 201 Created com os dados do cliente criado:

{
  "key": "xfrh3456s",
  "name": "João Silva",
  "email": "joao@example.com",
  "phone": "11999999999",
  "cpf": "123.456.789-00",
  "profession": "Engenheiro",
  "birthday": "1990-05-15",
  "place_of_birth": "São Paulo"
}

O campo key retornado é a client_key do cliente. Guarde esse valor — ele é necessário para associar o cliente a um ticket de atendimento ao usar o endpoint de criação de senhas.

IV – Erros comuns

• 400 Bad Request: verifique se o campo name está presente e se os valores respeitam os limites de caracteres de cada campo.
• 401 Unauthorized: a chave de API está ausente ou incorreta no cabeçalho Authorization. Acesse as configurações da plataforma para copiar a chave correta.

---

Com o cliente cadastrado, você pode associá-lo a um ticket de atendimento — veja como em Como Criar uma Senha de Atendimento via API. Para consultar os clientes já cadastrados na plataforma, acesse Como verificar a lista de clientes.