SOURCE: Vacation Tracker TITLE: Como uso a API aberta (OpenAPI)? URL: https://vacationtracker.io/pt/base-de-conhecimento/como-uso-a-api-aberta-openapi/ LANG: pt PUBLISHED: 2026-10-06 UPDATED: 2026-11-02 READING: 4 min SUMMARY: Como criar uma chave de API no complemento API Aberta do Vacation Tracker, escolher as permissões, fazer a primeira requisição, adicionar webhooks e conhecer as cotas e os limites. # Como uso a API aberta (OpenAPI)? # Como uso a API aberta (OpenAPI)? O nosso complemento API Aberta conecta o Vacation Tracker às suas próprias ferramentas. Crie uma chave de API, escolha o que ela pode fazer e use-a para ler e alterar os seus dados ou para ser notificado quando algo mudar. ### Assista ao tutorial Um passo a passo rápido do complemento API Aberta: ## Como criar uma chave de API - Faça login na sua conta do Vacation Tracker em app.vacationtracker.io/signin (https://app.vacationtracker.io/signin). - Abra Integrações no menu à esquerda (em Configurações do espaço de trabalho). - Clique no cartão API. Isso abre a página API Aberta. - Na seção Chaves de API, clique em Criar chave de API. - Digite um Nome da chave. Somente as pessoas da sua empresa veem esse nome. - Se quiser, digite um Nome da integração. As pessoas o veem no Vacation Tracker ao lado de cada alteração feita pela chave, por exemplo “Aprovado por Jane (via Payroll sync)”. Deixe-o vazio para mostrar apenas o nome da pessoa. - Em Permissões, escolha um modelo e ajuste-o se necessário (veja abaixo). - Em Expiração, escolha quando a chave expira: em 30 dias, em 90 dias, em 1 ano (recomendado) ou nunca. - Confira o Resumo e clique em Criar chave de API. - Copie a chave e guarde-a em um lugar seguro. A chave completa é exibida apenas uma vez, quando é criada. ## Como escolher as permissões Comece com um modelo e depois ajuste: - Somente leitura: vê os dados e não altera nada. Ideal para relatórios e dashboards. - Gestão de licenças: solicita, adiciona e aprova licenças. Lê usuários e tipos de licença. - Configuração do espaço de trabalho: configura localizações, departamentos, tipos de licença, políticas, feriados e usuários. - Personalizado: você escolhe cada permissão. Cada permissão pode ser definida como Sem acesso, Leitura ou Leitura e escrita. Aprovar e negar solicitações, ver nomes de tipos de licença ocultos e agir em nome de outros usuários são caixas de seleção separadas, então ative-as somente se a sua ferramenta precisar delas. Uma chave só pode fazer o que você tem permissão para fazer no Vacation Tracker. ## Como gerenciar as suas chaves A tabela Chaves de API lista todas as chaves do seu espaço de trabalho com o proprietário, as permissões, o último uso, a data de expiração e o status. Clique em uma chave para abrir os detalhes, onde você pode: - Ver o uso deste mês e editar o nome e as permissões da chave. - Consultar a Atividade recente, que lista todas as requisições que alteraram dados. - Clicar em Rotacionar chave para obter uma nova chave com o mesmo nome e as mesmas permissões. Escolha se a chave antiga continua funcionando por 24 horas (recomendado), por 7 dias ou se para imediatamente. - Clicar em Revogar para desativar a chave definitivamente. Enviamos um e-mail 14 dias antes de uma chave expirar. ## Fazer a sua primeira requisição A URL base é https://api.vacationtracker.io/v2. Envie a sua chave como um bearer token no cabeçalho Authorization: curl https://api.vacationtracker.io/v2/departments \ -H "Authorization: Bearer vt_live_..." Uma chamada bem-sucedida retorna os dados em data. As listas com mais páginas também incluem um nextToken, que você envia de volta para obter a próxima página. { "data": [ ... ], "nextToken": "..." } Se algo der errado, a resposta inclui um error com um código, uma descrição e uma solução. Uma chave ausente ou desconhecida retorna 401. Uma chave sem a permissão de que a requisição precisa retorna 403 com INSUFFICIENT_SCOPE. Referência técnica completa Todos os endpoints, parâmetros, códigos de erro e eventos de webhook estão na nossa documentação para desenvolvedores (https://vacationtracker.io/developers/api-v2). Você também pode abri-la com o botão Abrir Documentação na página do complemento API Aberta. ## Como adicionar um webhook - Na página do complemento API Aberta, vá para Webhooks e clique em Gerenciar webhooks. - Clique em Adicionar webhook. - Digite a URL do endpoint que deve receber os eventos. Ela precisa usar HTTPS. - Em Eventos, escolha Decisões sobre licenças, Toda a atividade de folgas, Manter uma cópia completa sincronizada ou Personalizado para escolher os eventos você mesmo. - Clique em Adicionar webhook. Você só recebe eventos dos dados que tem permissão para ver. ## Cotas e limites de taxa Os limites se aplicam por chave de API: - Até 30.000 requisições por mês. - 10 requisições por segundo, com picos de até 50 requisições. Se a sua integração precisar de mais, envie um e-mail para developers@vacationtracker.io (mailto:developers@vacationtracker.io) com o nome da sua empresa, a integração e o tráfego que você espera. Chaves de API antigas As chaves criadas antes da API v2 aparecem em Chaves legadas (API v1). Elas continuam funcionando, mas só podem ler dados e não funcionam com a API v2. Para alterar dados pela API, crie uma nova chave e siga o nosso guia de migração (https://vacationtracker.io/developers/api-v2/migration). ## Perguntas frequentes Devo usar a API, o Zapier ou o servidor MCP? Depende do que você está fazendo. A API é para o seu próprio código e as suas próprias ferramentas, com webhooks para reagir às mudanças. O Zapier é a opção sem código. O servidor MCP conecta uma ferramenta de IA como o Claude ou o ChatGPT para que você possa fazer perguntas em linguagem natural. Muitas equipes usam mais de uma opção. A API tem custo adicional? Não. O complemento API Aberta está incluído nos planos Core e Complete, sem custo adicional. E se eu perder uma chave? A chave completa é exibida apenas uma vez e não pode ser recuperada. Abra a chave e clique em Rotacionar chave para obter uma nova e depois atualize a ferramenta que a utiliza. Se a chave antiga puder ter vazado, escolha desativá-la imediatamente. ### Próximos passos Como conecto o Vacation Tracker ao Zapier? (https://vacationtracker.io/pt/base-de-conhecimento/como-conecto-o-vacation-tracker-ao-zapier/) Como conecto o Vacation Tracker às minhas ferramentas de IA com o servidor MCP? (https://vacationtracker.io/pt/base-de-conhecimento/como-conecto-o-vacation-tracker-as-minhas-ferramentas-de-ia-com-o-servidor-mcp/) Como exporto um relatório de solicitações de licença (histórico de licenças)? (https://vacationtracker.io/pt/base-de-conhecimento/como-exporto-um-relatorio-de-solicitacoes-de-licenca-historico-de-licencas/) Precisa de ajuda? Entre em contato com nossa equipe de suporte por e-mail ou chat, de segunda a sexta-feira, das 9h às 17h (horário do leste dos EUA, EST).