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.

Como criar uma chave de API

1. Faça login na sua conta do Vacation Tracker em app.vacationtracker.io/signin.
2. Abra Integrações no menu à esquerda (em Configurações do espaço de trabalho).
3. Clique no cartão API. Isso abre a página API Aberta.
4. Na seção Chaves de API, clique em Criar chave de API.
5. Digite um Nome da chave. Somente as pessoas da sua empresa veem esse nome.
6. 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.
7. Em Permissões, escolha um modelo e ajuste-o se necessário (veja abaixo).
8. Em Expiração, escolha quando a chave expira: em 30 dias, em 90 dias, em 1 ano (recomendado) ou nunca.
9. Confira o Resumo e clique em Criar chave de API.
10. 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:

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.

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.

Como adicionar um webhook

1. Na página do complemento API Aberta, vá para Webhooks e clique em Gerenciar webhooks.
2. Clique em Adicionar webhook.
3. Digite a URL do endpoint que deve receber os eventos. Ela precisa usar HTTPS.
4. 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.
5. 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 com o nome da sua empresa, a integração e o tráfego que você espera.

Perguntas frequentes