A API do Calendly conecta seus sistemas de software com nossa plataforma de agendamento. Você pode automatizar tarefas, sincronizar dados e melhorar o agendamento.
Este guia cobre o básico para ajudar você a começar. Confira o Portal do Desenvolvedor e a Comunidade de Desenvolvedores para obter ajuda avançada.
Como funciona a API do Calendly
Solicitação de API
Todos os usuários do Calendly podem enviar uma solicitação para obter informações ou concluir uma tarefa usando nossa API. Você incluirá de que tipo de dados ou ação você precisa na solicitação.
Cada solicitação é protegida com um token de acesso pessoal (PAT), que permite à API saber o que você pode fazer. Nossas páginas de referência no portal explicam como formatar sua solicitação e incluem todos os detalhes necessários.
Processamento de API
Quando uma solicitação é enviada, nossos servidores coletam dados, processam cálculos ou concluem tarefas com base nas suas informações. O servidor envia uma resposta que corresponde à sua solicitação.
Exemplo de solicitação:
Resposta
Assim que sua solicitação é processada, uma resposta é enviada a você. Ele incluirá os dados solicitados ou confirmará que a ação foi concluída. Todas as respostas seguem os formatos padrão de API.
Exemplo de resposta:
Tratamento de erros
Se um erro acontecer, ele é tratado com mensagens e códigos predefinidos. Isso ajuda com solução de problemas ou quando você precisa de suporte da equipe do Calendly.
Exemplo de erro:
Webhooks
Disponível nos planos Professional, Standard, Teams e Enterprise
Webhooks fornecem atualizações em tempo real para seus sistemas quando eventos ocorrem no Calendly. Uma vez configurado, o Calendly irá notificá-lo instantaneamente se uma reunião for agendada, remarcada ou cancelada. Isso permite automatizar tarefas ou acionar ações com base nessas atualizações. Para mais detalhes, consulte nosso artigo sobre webhooks.
Acesso à API por plano de assinatura
Os desenvolvedores podem fazer solicitações GET e POST para endpoints da API em nome de um usuário do Calendly em qualquer plano de assinatura, incluindo o plano Basic.
No entanto, determinados pontos finais estão disponíveis apenas no plano Enterprise:
- Listar registros de entrada de atividades
- Excluir dados de convidado
- Excluir dados de eventos agendados
Para webhooks, o usuário do Calendly deve ter uma assinatura paga no plano Professional, Standard, Teams ou Enterprise. Explore os recursos de cada plano em nossa página de valores.
Escopos de usuário versus administrador/proprietário
Ao gerar tokens para autenticar a API do Calendly, o nível de acesso depende da função do usuário. O escopo dos dados disponíveis depende se o token é gerado por um usuário ou um administrador/proprietário:
- Função de usuário: um token gerado por um usuário permite apenas acesso a dados vinculados a esse usuário específico. Isso inclui webhooks que acionam eventos como reuniões agendadas ou canceladas relacionadas ao usuário individual.
- Função de administrador/proprietário: os tokens gerados por um administrador ou proprietário fornecem acesso mais amplo. Esses tokens permitem que as chamadas de API gerenciem dados em toda a organização ou dentro de grupos.
Crie um token de acesso pessoal
Certifique-se de que está gerando o token da conta correta (usuário ou administrador/proprietário) para definir o escopo apropriado de acesso.
- Visite sua página de Integrações e selecione API e webhooks.
- Selecione Obter um token agora.
- Em Escolha um nome para este token, adicione um nome.
- Selecione Criar token.
- Você será solicitado a inserir um código de autenticação. Verifique seu e-mail para obter o código e insira-o para concluir a verificação.
- Assim que o token de acesso pessoal for gerado, selecione Copiar token.
Depois de gerar seu token de acesso pessoal, confira nosso guia sobre recursos de API e criação de integrações em nosso Guia de Introdução no Portal do Desenvolvedor.
Observação
Mantenha seus tokens de acesso pessoais privados e seguros, assim como uma senha.
Segurança e conformidade
A segurança da sua integração é nossa principal prioridade. Nossa API adere às práticas recomendadas de segurança e conformidade de dados, garantindo que suas informações permaneçam seguras. Para mais detalhes, consulte nosso artigo Segurança e Conformidade da Plataforma Calendly.
Por meio da API, você pode criar e gerenciar usuários da organização através de:
- Convidar usuários para ingressar na sua organização
- Revogar convites
- Remover usuários da sua organização
Você também pode integrar seu aplicativo usando OAuth 2.0 para autorização segura.