Documentación / Recursos Avançados
Recursos Avançados

Cómo Registrar Clientes (Personas) Vía API

registrar clientes

Resumen

La API de la plataforma eAgenda permite registrar clientes (personas) de forma programática, agregando información como nombre, correo electrónico, teléfono y documentos de identificación. Esta guía práctica detalla cómo enviar una solicitud HTTP POST al endpoint /api/v3/people/ y procesar la respuesta. Para más detalles, consulte la documentación oficial de la API de eAgenda: https://eagenda.com.br/api/v3/documentation/#overview.

Preparación del Entorno

Antes de comenzar, necesitará:

  • Clave de API: Acceda al panel de eAgenda para obtener su token Bearer (consulte el tutorial “Cómo Autenticarse en la API”).
  • Herramienta para solicitudes HTTP: Use cURL, Postman o bibliotecas como requests (Python) o axios (JavaScript).
  • Configuración del encabezado: La autenticación se realiza mediante Bearer Token. Configure el encabezado Authorization: Bearer y defina Content-Type: application/json.

Consejo: Consulte la sección de autenticación en la documentación de la API para configurar el token correctamente: https://eagenda.com.br/api/v3/documentation/#overview.

Definición de los Datos del Cliente

Para registrar un cliente, envíe un objeto JSON en el cuerpo de la solicitud con los siguientes campos:

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

name (obligatorio)

  • Descripción: Nombre completo del cliente.
  • Restricciones: 1 a 200 caracteres.
  • Impacto: Identifica al cliente en el sistema.
  • Ejemplo: “João Silva”

email (opcional)

  • Descripción: Correo electrónico del cliente.
  • Impacto: Utilizado para notificaciones e identificación única.
  • Ejemplo: “joao.silva@example.com”

phone (opcional)

  • Descripción: Teléfono del cliente en formato E.164.
  • Impacto: Agrega un contacto telefónico para el cliente.
  • Ejemplo: “+5511999999999”

identification_code (opcional)

  • Descripción: Número del documento de identificación del cliente.
  • Impacto: Vincula al cliente con un documento oficial.
  • Ejemplo: “123.456.789-00”

identification_type (opcional)

  • Descripción: Tipo del documento de identificación.
  • Valores posibles: 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 el tipo de documento proporcionado en identification_code.
  • Ejemplo: “br_cpf”

Nota: El campo name es obligatorio. Los demás son opcionales, pero se recomiendan para mayor detalle e integración con citas.

Ejemplo Básico:

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

Envío de la Solicitud para Registrar un Cliente

Para registrar un cliente, envíe una solicitud HTTP POST al endpoint:

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

Configuración de la Solicitud

  • Método: POST
  • Encabezados:
    • accept: application/json
    • Authorization: Bearer
    • Content-Type: application/json
  • Cuerpo de la solicitud: JSON con los datos del cliente.

Ejemplo de Solicitud con 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"
}'

Ejemplo en 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())

Verificación de la Respuesta

La API devolverá una respuesta con el estado de la creación del cliente. Verifique los siguientes puntos:

  • Código de estado HTTP:
    • 201 Created: Cliente registrado con éxito.
    • 400 Bad Request: Error en los datos enviados (verifique el JSON).
    • 401 Unauthorized: Token inválido o ausente.
  • Cuerpo de la respuesta: Contiene los detalles del cliente registrado, 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" }

El cliente quedará registrado en el sistema y podrá ser vinculado a citas u otras operaciones. Use el person_key para referenciar al cliente en otras solicitudes.

Conclusión

Con este tutorial, aprendió cómo registrar clientes (personas) vía API de eAgenda, configurando información como nombre, correo electrónico, teléfono y documentos de identificación de forma eficiente. Esta integración es ideal para automatizar el registro de clientes, facilitando la gestión de contactos en el sistema. Para más funcionalidades, como crear citas o cuentas, consulte la documentación completa de la API de eAgenda: https://eagenda.com.br/api/v3/documentation/#overview.

Contáctenos o Conozca Más

Estamos a su disposición para ayudarle con cualquier consulta. Acceda a nuestros canales oficiales:

📞 WhatsApp : Haga clic aquí para enviarnos un mensaje 🌐 Plataforma eAgenda : Conozca eAgenda 🏢 Nuestra Empresa : Mupi Systems – Soluciones Innovadoras 📧 Correo electrónico : contato@mupisystems.com.br 📚 Tutoriales y Documentación : Acceda a nuestras guías y tutoriales