Como Cadastrar Clientes (Pessoas) Via API

Resumo #

A API da plataforma eAgenda permite cadastrar clientes (pessoas) de forma programática, adicionando informações como nome, e-mail, telefone e documentos de identificação. Este guia prático detalha como enviar uma requisição HTTP POST para o endpoint /api/v3/people/ e processar a resposta. Para mais detalhes, consulte a documentação oficial da API da eAgenda: https://eagenda.com.br/api/v3/documentation/#overview.

Preparação do Ambiente #

Antes de começar, você precisará:

• Chave de API: Acesse o painel da eAgenda para obter seu token Bearer (consulte o tutorial “Como Autenticar na API”).
• Ferramenta para requisições HTTP: Use cURL, Postman ou bibliotecas como requests (Python) ou axios (JavaScript).
• Configuração do cabeçalho: A autenticação é feita via Bearer Token. Configure o cabeçalho Authorization: Bearer <seu-token> e defina Content-Type: application/json.

Dica: Consulte a seção de autenticação na documentação da API para configurar o token corretamente: https://eagenda.com.br/api/v3/documentation/#overview.

Definição dos Dados do Cliente #

Para cadastrar um cliente, envie um objeto JSON no corpo da requisição com os seguintes campos:

{
  "name": "string",
  "email": "email",
  "phone": "string",
  "identification_code": "string",
  "identification_type": "string"
}

name (obrigatório) #

• Descrição: Nome completo do cliente.
• Restrições: 1 a 200 caracteres.
• Impacto: Identifica o cliente no sistema.
• Exemplo: “João Silva”

email (opcional) #

• Descrição: E-mail do cliente.
• Impacto: Usado para notificações e identificação única.
• Exemplo: “joao.silva@example.com”

phone (opcional) #

• Descrição: Telefone do cliente no formato E.164.
• Impacto: Adiciona um contato telefônico para o cliente.
• Exemplo: “+5511999999999”

identification_code (opcional) #

• Descrição: Número do documento de identificação do cliente.
• Impacto: Vincula o cliente a um documento oficial.
• Exemplo: “123.456.789-00”

identification_type (opcional) #

• Descrição: Tipo do documento de identificação.
• Valores possíveis: ar_dni, bo_ci, br_cpf, cl_run, co_cc, ec_ci, py_ci, pe_dni, uy_ci, ve_ci, ca_sin, mx_curp, us_ssn, jm_nin, gt_cui, hn_ci, cr_ci, do_ci, pa_ci, cn_ric, in_uid, id_nik, jp_myn, sa_id, kr_rrn, au_medicare, eg_nid, gh_card, ke_nin, ng_nin, za_id, ao_bi, mz_bi, de_personalausweis, es_dni_nie, fr_nir, it_cf, nl_bsn, pl_pesel, pt_nif_cc, se_personnummer, tr_tckn, uk_nin.
• Impacto: Especifica o tipo do documento fornecido em identification_code.
• Exemplo: “br_cpf”

Nota: O campo name é obrigatório. Os demais são opcionais, mas recomendados para maior detalhamento e integração com agendamentos.

Exemplo Básico:

{
  "name": "João Silva",
  "email": "joao.silva@example.com",
  "phone": "+5511999999999",
  "identification_code": "123.456.789-00",
  "identification_type": "br_cpf"
}

Envio da Requisição para Cadastrar Clientea #

Para cadastrar um cliente, envie uma requisição HTTP POST para o endpoint:

https://eagenda.com.br/api/v3/people/

Configuração da Requisição #

• Método: POST
• Cabeçalhos:
  • accept: application/json
  • Authorization: Bearer <seu-token>
  • Content-Type: application/json
• Corpo da requisição: JSON com os dados do cliente.

Exemplo de Requisição com cURL #

curl -X POST https://eagenda.com.br/api/v3/people/ \
-H "accept: application/json" \
-H "Authorization: Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999" \
-H "Content-Type: application/json" \
-d '{
  "name": "João Silva",
  "email": "joao.silva@example.com",
  "phone": "+5511999999999",
  "identification_code": "123.456.789-00",
  "identification_type": "br_cpf"
}'

Exemplo em Python (usando requests) #

import requests

url = "https://eagenda.com.br/api/v3/people/"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999",
    "Content-Type": "application/json"
}
data = {
    "name": "João Silva",
    "email": "joao.silva@example.com",
    "phone": "+5511999999999",
    "identification_code": "123.456.789-00",
    "identification_type": "br_cpf"
}

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

Verificação da Resposta #

A API retornará uma resposta com o status da criação do cliente. Verifique os seguintes pontos:

• Código de status HTTP:
  • 201 Created: Cliente cadastrado com sucesso.
  • 400 Bad Request: Erro nos dados enviados (verifique o JSON).
  • 401 Unauthorized: Token inválido ou ausente.
• Corpo da resposta: Contém os detalhes do cliente cadastrado, como:

{ "person_key": "19753164-d190-4000-842c-43b82d3db780", "name": "João Silva", "email": "joao.silva@example.com", "phone": "+5511999999999", "identification_code": "123.456.789-00", "identification_type": "br_cpf" }

O cliente será registrado no sistema e poderá ser vinculado a agendamentos ou outras operações. Use o person_key para referenciar o cliente em outras requisições.

Conclusão #

Com este tutorial, você aprendeu como cadastrar clientes (pessoas) via API da eAgenda, configurando informações como nome, e-mail, telefone e documentos de identificação de forma eficiente. Essa integração é ideal para automatizar o cadastro de clientes, facilitando a gestão de contatos no sistema. Para mais funcionalidades, como criar agendamentos ou contas, consulte a documentação completa da API da eAgenda: https://eagenda.com.br/api/v3/documentation/#overview.

Entre em Contato ou Saiba Mais #

Estamos à disposição para ajudar em qualquer dúvida! Acesse nossos canais oficiais:

📞 WhatsApp : Clique aqui para nos enviar uma mensagem
🌐 Plataforma eAgenda : Conheça o eAgenda
🏢 Nossa Empresa : Mupi Systems – Soluções Inovadoras
📧 E-mail : contato@mupisystems.com.br
📚 Tutoriais e Documentação : Acesse nossos guias e tutoriais