Criar uma Conta

A API da plataforma eAgenda permite criar uma conta (organizações) de forma programática, configurando informações como nome, contato, fuso horário e status. Este guia prático detalha como enviar uma requisição HTTP POST para o endpoint /api/v3/accounts/ e processar a resposta. Para mais detalhes, consulte a documentação oficial da API da eAgenda: https://eagenda.com.br/api/v3/documents/#overview.

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 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/documents/#overview.

Definição dos Dados da Conta

Para criar uma conta, envie um objeto JSON no corpo da requisição com os seguintes campos:

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

slug (obrigatório)

Descrição: Identificador único da organização (slug).
Restrições: Mínimo de 1 caractere, padrão ^[-a-zA-Z0-9_]+$.
Impacto: Usado para identificar a conta no sistema.
Exemplo: “minha-organizacao”

name (opcional)

Descrição: Nome da empresa ou negócio.
Restrições: Máximo de 50 caracteres.
Impacto: Define o nome visível da organização.
Exemplo: “Minha Saúde Ltda”

website (opcional)

Descrição: URL do site da organização.
Restrições: Máximo de 250 caracteres.
Impacto: Adiciona um link para o site da empresa.
Exemplo: “https://www.minhasaude.com.br”

email (opcional)

Descrição: E-mail de contato da organização.
Impacto: Usado para comunicações relacionadas à conta.
Exemplo: “contato@minhasaude.com.br”

phone (opcional)

Descrição: Telefone de contato da organização.
Restrições: Máximo de 15 caracteres.
Impacto: Adiciona um número de contato.
Exemplo: “+5511999999999”

url_domain (opcional)

Descrição: URL da página de agendamento no site da organização.
Impacto: Vincula a conta a uma página de agendamento personalizada.
Exemplo: “https://agendamento.minhasaude.com.br”

time_zone (opcional)

Descrição: Fuso horário da organização.
Restrições: Deve ser um fuso horário válido (ex.: America/Sao_Paulo).
Impacto: Define o fuso horário para agendamentos e notificações.
Exemplo: “America/Sao_Paulo”

is_active (opcional)

Descrição: Status da organização.
Impacto: Determina se a conta está ativa (true) ou inativa (false).
Exemplo: true

Nota: O campo slug é obrigatório. Os demais são opcionais, mas recomendados para maior controle e personalização.

Exemplo Básico:

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

Envio da Requisição para Criar uma Conta

Para criar uma conta, envie uma requisição HTTP POST para o endpoint:

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

Configuração da Requisição

Método: POST
Cabeçalhos:
- accept: application/json
- Authorization: Bearer
- Content-Type: application/json
Corpo da requisição: JSON com os dados da conta.

Exemplo de Requisição com cURL

curl -X POST https://eagenda.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": "+5511999999999",
  "url_domain": "https://agendamento.minhasaude.com.br",
  "time_zone": "America/Sao_Paulo",
  "is_active": true
}'

Exemplo em Python (usando requests)

import requests

url = "https://eagenda.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": "+5511999999999",
    "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())

Verificação da Resposta

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

Código de status HTTP:
- 201 Created: Conta criada 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 da conta criada, como:

{
  "slug": "minha-organizacao",
  "name": "Minha Saúde Ltda",
  "website": "https://www.minhasaude.com.br",
  "email": "contato@minhasaude.com.br",
  "phone": "+5511999999999",
  "url_domain": "https://agendamento.minhasaude.com.br",
  "time_zone": "America/Sao_Paulo",
  "is_active": true,
  "is_sub_account": false
}

A conta será registrada no sistema e estará pronta para ser usada em outras operações, como criação de agendas ou agendamentos.

Conclusão

Com este tutorial, você aprendeu como criar uma conta (organização) via API da eAgenda, configurando detalhes como slug, nome, contato e fuso horário de forma eficiente. Essa integração é ideal para automatizar a criação de organizações, facilitando a gestão de contas no sistema. Para mais funcionalidades, como criar agendas ou agendamentos, 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