Como Crear una Cuenta (Organizacion) Via API

Pregúntale a la IA

La API de la plataforma Minha Agenda Virtual permite crear una cuenta (organizaciones) de forma programatica, configurando informacion como nombre, contacto, zona horaria y estado. Esta guia practica detalla como enviar una solicitud HTTP POST al endpoint /api/v3/accounts/ y procesar la respuesta. Para mas detalles, consulte la documentacion oficial de la API de Minha Agenda Virtual: https://eagenda.com.br/api/v3/documents/#overview.

Preparacion del Entorno

Antes de comenzar, necesitara:

  • Clave de API: Acceda al panel de Minha Agenda Virtual para obtener su token Bearer.
  • Herramienta para solicitudes HTTP: Use cURL, Postman o bibliotecas como requests (Python) o axios (JavaScript).
  • Configuracion del encabezado: La autenticacion se realiza via Bearer Token. Configure el encabezado Authorization: Bearer y defina Content-Type: application/json.

Consejo: Consulte la seccion de autenticacion en la documentacion de la API para configurar el token correctamente: https://eagenda.com.br/api/v3/documents/#overview.

Definicion de los Datos de la Cuenta

Para crear una cuenta, envie un objeto JSON en el cuerpo de la solicitud con los siguientes campos:

{
  "slug": "string",
  "name": "string",
  "website": "string",
  "email": "email",
  "phone": "string",
  "url_domain": "uri",
  "time_zone": "string",
  "is_active": boolean
}

slug (obligatorio)

  • Descripcion: Identificador unico de la organizacion (slug).
  • Restricciones: Minimo de 1 caracter, patron ^[-a-zA-Z0-9_]+$.
  • Impacto: Usado para identificar la cuenta en el sistema.
  • Ejemplo: “minha-organizacao”

name (opcional)

  • Descripcion: Nombre de la empresa o negocio.
  • Restricciones: Maximo de 50 caracteres.
  • Impacto: Define el nombre visible de la organizacion.
  • Ejemplo: “Minha Saúde Ltda”

website (opcional)

  • Descripcion: URL del sitio web de la organizacion.
  • Restricciones: Maximo de 250 caracteres.
  • Impacto: Agrega un enlace al sitio web de la empresa.
  • Ejemplo: “https://www.minhasaude.com.br”

email (opcional)

  • Descripcion: Correo electronico de contacto de la organizacion.
  • Impacto: Usado para comunicaciones relacionadas con la cuenta.
  • Ejemplo: “contato@minhasaude.com.br”

phone (opcional)

  • Descripcion: Telefono de contacto de la organizacion.
  • Restricciones: Maximo de 15 caracteres.
  • Impacto: Agrega un numero de contacto.
  • Ejemplo: “+5511942529100”

url_domain (opcional)

  • Descripcion: URL de la pagina de agendamiento en el sitio web de la organizacion.
  • Impacto: Vincula la cuenta a una pagina de agendamiento personalizada.
  • Ejemplo: “https://agendamento.minhasaude.com.br”

time_zone (opcional)

  • Descripcion: Zona horaria de la organizacion.
  • Restricciones: Debe ser una zona horaria valida (ej.: America/Sao_Paulo).
  • Impacto: Define la zona horaria para agendamientos y notificaciones.
  • Ejemplo: “America/Sao_Paulo”

is_active (opcional)

  • Descripcion: Estado de la organizacion.
  • Impacto: Determina si la cuenta esta activa (true) o inactiva (false).
  • Ejemplo: true

Nota: El campo slug es obligatorio. Los demas son opcionales, pero recomendados para mayor control y personalizacion.

Ejemplo Basico:

{
  "slug": "minha-organizacao",
  "name": "Minha Saúde Ltda",
  "email": "contato@minhasaude.com.br",
  "time_zone": "America/Sao_Paulo",
  "is_active": true
}

Envio de la Solicitud para Crear una Cuenta

Para crear una cuenta, envie una solicitud HTTP POST al endpoint:

https://minhaagendavirtual.com.br/api/v3/accounts/

Configuracion de la Solicitud

  • Metodo: POST
  • Encabezados:
    • accept: application/json
    • Authorization: Bearer
    • Content-Type: application/json
  • Cuerpo de la solicitud: JSON con los datos de la cuenta.

Ejemplo de Solicitud con cURL

curl -X POST https://minhaagendavirtual.com.br/api/v3/accounts/ \
-H "accept: application/json" \
-H "Authorization: Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999" \
-H "Content-Type: application/json" \
-d '{
  "slug": "minha-organizacao",
  "name": "Minha Saúde Ltda",
  "website": "https://www.minhasaude.com.br",
  "email": "contato@minhasaude.com.br",
  "phone": "+5511942529100",
  "url_domain": "https://agendamento.minhasaude.com.br",
  "time_zone": "America/Sao_Paulo",
  "is_active": true
}'

Ejemplo en Python (usando requests)

import requests

url = "https://minhaagendavirtual.com.br/api/v3/accounts/"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999",
    "Content-Type": "application/json"
}
data = {
    "slug": "minha-organizacao",
    "name": "Minha Saúde Ltda",
    "website": "https://www.minhasaude.com.br",
    "email": "contato@minhasaude.com.br",
    "phone": "+5511942529100",
    "url_domain": "https://agendamento.minhasaude.com.br",
    "time_zone": "America/Sao_Paulo",
    "is_active": True
}

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

Verificacion de la Respuesta

La API retornara una respuesta con el estado de la creacion de la cuenta. Verifique los siguientes puntos:

  • Codigo de estado HTTP:
    • 201 Created: Cuenta creada con exito.
    • 400 Bad Request: Error en los datos enviados (verifique el JSON).
    • 401 Unauthorized: Token invalido o ausente.
  • Cuerpo de la respuesta: Contiene los detalles de la cuenta creada, como:
{
  "slug": "minha-organizacao",
  "name": "Minha Saúde Ltda",
  "website": "https://www.minhasaude.com.br",
  "email": "contato@minhasaude.com.br",
  "phone": "+5511942529100",
  "url_domain": "https://agendamento.minhasaude.com.br",
  "time_zone": "America/Sao_Paulo",
  "is_active": true,
  "is_sub_account": false
}

La cuenta quedara registrada en el sistema y estara lista para ser usada en otras operaciones, como creacion de agendas o citas.

Conclusion

Con este tutorial, aprendio como crear una cuenta (organizacion) via API de Minha Agenda Virtual, configurando detalles como slug, nombre, contacto y zona horaria de forma eficiente. Esta integracion es ideal para automatizar la creacion de organizaciones, facilitando la gestion de cuentas en el sistema. Para mas funcionalidades, como crear agendas o citas, consulte la documentacion completa de la API de Minha Agenda Virtual.

Contactenos o Sepa Mas

Estamos a su disposicion para ayudarle. Acceda a nuestros canales oficiales:

📞 WhatsApp : Haga clic aqui para enviarnos un mensaje 🌐 Plataforma Minha Agenda Virtual : Conozca Minha Agenda Virtual 🏢 Nuestra Empresa : Mupi Systems – Soluciones Innovadoras 📧 Correo electronico : contato@mupisystems.com.br 📚 Tutoriales y Documentacion : Acceda a nuestras guias y tutoriales