Como Criar Usuários (Colaboradores) Via API

Resumo #

A API da plataforma eAgenda permite criar usuários (colaboradores) de forma programática, possibilitando a automação do cadastro de membros com permissões específicas, como proprietários, administradores, colaboradores ou visualizadores. Este guia prático detalha como configurar uma requisição HTTP POST para o endpoint /api/v3/users/ e processar a resposta. Para mais detalhes, consulte a documentação oficial da API da eAgenda.

Preparação do Ambiente #

Antes de começar, você precisará:

• Chave de API: Acesse o painel da eAgenda para obter seu token Bearer.
• 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 documentação de autenticação da eAgenda para configurar o token corretamente.

Definição dos Dados do Usuário #

Para criar um usuário (colaborador), envie um objeto JSON no corpo da requisição com os seguintes campos:

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

full_name (opcional) #

• Descrição: Nome completo do colaborador.
• Restrições: Máximo de 50 caracteres.
• Impacto: Identifica o colaborador de forma amigável no sistema.
• Exemplo: “João Silva”

email (obrigatório) #

• Descrição: E-mail válido do colaborador.
• Impacto: Usado para login e notificações.
• Exemplo: “joao.silva@example.com”

password (opcional) #

• Descrição: Senha do colaborador.
• Restrições: Mínimo de 1 caractere.
• Impacto: Define as credenciais de acesso. Se não fornecida, o sistema pode exigir configuração posterior.
• Exemplo: “senha123”

accounts (opcional) #

• Descrição: Lista de contas ou subcontas às quais o colaborador terá acesso.
• Estrutura: Array de objetos JSON, cada um com:
  • profile_type (obrigatório): Tipo de perfil (owner, manager, oper, read).
    • owner: Proprietário da conta.
    • manager: Administrador.
    • oper: Colaborador.
    • read: Apenas visualização.
  • is_active (opcional): Status do colaborador na conta (padrão: true).
  • account_slug (obrigatório): Slug da conta (padrão: ^[-a-zA-Z0-9_]+$).
• Como obter o account_slug: Use o endpoint de listagem de contas da eAgenda (consulte a documentação).
• Impacto: Define as permissões e o acesso do colaborador às contas.
• Exemplo:[ { "profile_type": "oper", "is_active": true, "account_slug": "minha-conta" } ]

Nota: O único campo obrigatório é email. Os campos full_name, password e accounts são opcionais, mas recomendados para configurar permissões específicas.

Envio da Requisição para Criar Usuários #

Para criar o usuário (colaborador), envie uma requisição HTTP POST para o endpoint:

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

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 usuário.

Exemplo de Requisição com 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"
    }
  ]
}'

Exemplo em 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())

Verificação da Resposta #

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

• Código de status HTTP:
  • 201 Created: Usuário criado com sucesso.
  • 400 Bad Request: Erro nos dados enviados (verifique o JSON).
  • 401 Unauthorized: Token inválido ou ausente.
• Corpo da resposta: Contém detalhes do usuário criado, 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" } ] }

O usuário será registrado no sistema com as permissões definidas. Você pode usar outros endpoints da API para gerenciar ou consultar colaboradores.

Conclusão #

Com este tutorial, você aprendeu como criar usuários (colaboradores) via API da eAgenda, automatizando o cadastro e definindo permissões específicas. Essa integração é ideal para gerenciar equipes e contas de forma eficiente. Para mais funcionalidades, como edição de usuários ou gerenciamento de contas, consulte a documentação completa da API da eAgenda.

Entre em Contato ou Saiba Mais #

Estamos à disposição para ajudar! 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