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

Como Crear Usuarios (Colaboradores) Via API

Crear Usuarios

Resumen

La API de la plataforma eAgenda permite crear usuarios (colaboradores) de forma programatica, posibilitando la automatizacion del registro de miembros con permisos especificos, como propietarios, administradores, colaboradores o visualizadores. Esta guia practica detalla como configurar una solicitud HTTP POST al endpoint /api/v3/users/ y procesar la respuesta. Para mas detalles, consulte la documentacion oficial de la API de eAgenda.

Preparacion del Entorno

Antes de comenzar, necesitara:

  • Clave de API: Acceda al panel de eAgenda 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 documentacion de autenticacion de eAgenda para configurar el token correctamente.

Definicion de los Datos del Usuario

Para crear un usuario (colaborador), envie un objeto JSON en el cuerpo de la solicitud con los siguientes campos:

{
  "full_name": "string",
  "email": "string",
  "password": "string",
  "accounts": [
    {
      "profile_type": "string",
      "is_active": boolean,
      "account_slug": "string"
    }
  ]
}

full_name (opcional)

  • Descripcion: Nombre completo del colaborador.
  • Restricciones: Maximo de 50 caracteres.
  • Impacto: Identifica al colaborador de forma amigable en el sistema.
  • Ejemplo: “João Silva”

email (obligatorio)

  • Descripcion: Correo electronico valido del colaborador.
  • Impacto: Usado para inicio de sesion y notificaciones.
  • Ejemplo: “joao.silva@example.com”

password (opcional)

  • Descripcion: Contrasena del colaborador.
  • Restricciones: Minimo de 1 caracter.
  • Impacto: Define las credenciales de acceso. Si no se proporciona, el sistema puede requerir configuracion posterior.
  • Ejemplo: “senha123”

accounts (opcional)

  • Descripcion: Lista de cuentas o subcuentas a las que el colaborador tendra acceso.
  • Estructura: Array de objetos JSON, cada uno con:
    • profile_type (obligatorio): Tipo de perfil (owner, manager, oper, read).
      • owner: Propietario de la cuenta.
      • manager: Administrador.
      • oper: Colaborador.
      • read: Solo visualizacion.
    • is_active (opcional): Estado del colaborador en la cuenta (predeterminado: true).
    • account_slug (obligatorio): Slug de la cuenta (patron: ^[-a-zA-Z0-9_]+$).
  • Como obtener el account_slug: Use el endpoint de listado de cuentas de eAgenda (consulte la documentacion).
  • Impacto: Define los permisos y el acceso del colaborador a las cuentas.
  • Ejemplo:[ { "profile_type": "oper", "is_active": true, "account_slug": "minha-conta" } ]

Nota: El unico campo obligatorio es email. Los campos full_name, password y accounts son opcionales, pero recomendados para configurar permisos especificos.

Envio de la Solicitud para Crear Usuarios

Para crear el usuario (colaborador), envie una solicitud HTTP POST al endpoint:

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

Configuracion de la Solicitud

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

Ejemplo de Solicitud con cURL

curl -X POST https://eagenda.com.br/api/v3/users/ \
-H "accept: application/json" \
-H "Authorization: Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999" \
-H "Content-Type: application/json" \
-d '{
  "full_name": "João Silva",
  "email": "joao.silva@example.com",
  "password": "Senha@123",
  "accounts": [
    {
      "profile_type": "oper",
      "is_active": true,
      "account_slug": "minha-conta"
    }
  ]
}'

Ejemplo en Python (usando requests)

import requests

url = "https://eagenda.com.br/api/v3/users/"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999",
    "Content-Type": "application/json"
}
data = {
    "full_name": "João Silva",
    "email": "joao.silva@example.com",
    "password": "senha123",
    "accounts": [
        {
            "profile_type": "oper",
            "is_active": True,
            "account_slug": "minha-conta"
        }
    ]
}

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 del usuario. Verifique los siguientes puntos:

  • Codigo de estado HTTP:
    • 201 Created: Usuario creado 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 del usuario creado, como:{ "full_name": "João Silva", "email": "joao.silva@example.com", "accounts": [ { "user_profile_key": "1973042a-0d20-4000-8eed-656648396019", "profile_type": "oper", "is_active": true, "account_slug": "minha-conta" } ] }

El usuario quedara registrado en el sistema con los permisos definidos. Puede usar otros endpoints de la API para gestionar o consultar colaboradores.

Conclusion

Con este tutorial, aprendio como crear usuarios (colaboradores) via API de eAgenda, automatizando el registro y definiendo permisos especificos. Esta integracion es ideal para gestionar equipos y cuentas de forma eficiente. Para mas funcionalidades, como edicion de usuarios o gestion de cuentas, consulte la documentacion completa de la API de eAgenda.

Contactenos o Sepa Mas

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

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