Comment utiliser l'API ouverte (OpenAPI) ?

Notre extension API ouverte relie Vacation Tracker à vos propres outils. Créez une clé API, choisissez ce qu'elle peut faire, puis utilisez-la pour lire et modifier vos données ou être averti lorsque quelque chose change.

Comment créer une clé API

1. Connectez-vous à votre compte Vacation Tracker sur app.vacationtracker.io/signin.
2. Ouvrez Extensions dans le menu de gauche.
3. Dans l'onglet Mes extensions, trouvez API ouverte et cliquez sur Afficher. Si elle n'y figure pas, trouvez-la dans l'onglet Découvrez plus d'extensions et activez-la d'abord.
4. Dans la section Clés API, cliquez sur Créer une clé API.
5. Saisissez un Nom de la clé. Seules les personnes de votre entreprise voient ce nom.
6. Saisissez éventuellement un Nom de l'intégration. Il s'affiche dans Vacation Tracker à côté de chaque modification effectuée avec la clé, par exemple « Approuvé par Jane (via Payroll sync) ». Laissez-le vide pour n'afficher que le nom de la personne.
7. Sous Autorisations, choisissez un modèle et ajustez-le si nécessaire (voir ci-dessous).
8. Sous Expiration, choisissez quand la clé expire : dans 30 jours, dans 90 jours, dans 1 an (recommandé) ou jamais.
9. Vérifiez le Récapitulatif et cliquez sur Créer une clé API.
10. Copiez la clé et conservez-la en lieu sûr. La clé complète n'est affichée qu'une seule fois, lors de sa création.

Choisir les autorisations

Partez d'un modèle, puis ajustez-le :

• Lecture seule : consulter les données sans rien modifier. Idéal pour les rapports et les tableaux de bord.
• Gestion des congés : demander, ajouter et approuver des congés. Lire les utilisateurs et les types de congés.
• Configuration de l'espace de travail : configurer les sites, les services, les types de congés, les politiques, les jours fériés et les utilisateurs.
• Personnalisé : choisir vous-même chaque autorisation.

Chaque autorisation peut être réglée sur Aucun accès, Lecture ou Lecture et écriture. Approuver et refuser des demandes, voir les noms des types de congés masqués et agir au nom d'autres utilisateurs sont des cases à cocher distinctes : ne les activez que si votre outil en a besoin. Une clé ne peut faire que ce que vous êtes autorisé à faire dans Vacation Tracker.

Gérer vos clés

Le tableau Clés API liste toutes les clés de votre espace de travail avec leur propriétaire, leurs autorisations, leur dernière utilisation, leur date d'expiration et leur état. Cliquez sur une clé pour ouvrir ses détails, où vous pouvez :

• Voir l'utilisation du mois en cours et modifier le nom et les autorisations de la clé.
• Consulter l'Activité récente, qui liste chaque requête ayant modifié des données.
• Cliquer sur Renouveler la clé pour obtenir une nouvelle clé avec le même nom et les mêmes autorisations. Choisissez si l'ancienne clé continue de fonctionner pendant 24 heures (recommandé), pendant 7 jours ou cesse de fonctionner immédiatement.
• Cliquer sur Révoquer pour désactiver définitivement la clé.

Nous vous envoyons un e-mail 14 jours avant l'expiration d'une clé.

Envoyer votre première requête

L'URL de base est https://api.vacationtracker.io/v2. Envoyez votre clé comme jeton bearer dans l'en-tête Authorization :

Un appel réussi renvoie les données sous data. Les listes comportant plusieurs pages incluent aussi un nextToken, que vous renvoyez pour obtenir la page suivante.

En cas de problème, la réponse contient une error avec un code, une description et une solution. Une clé absente ou inconnue renvoie le code 401. Une clé qui n'a pas l'autorisation nécessaire à une requête renvoie le code 403 avec INSUFFICIENT_SCOPE.

Comment ajouter un webhook

1. Sur la page de l'extension API ouverte, allez dans Webhooks et cliquez sur Gérer les webhooks.
2. Cliquez sur Ajouter un webhook.
3. Saisissez l'URL du point de terminaison qui doit recevoir les événements. Elle doit utiliser HTTPS.
4. Sous Événements, choisissez Décisions sur les congés, Toute l'activité liée aux absences, Garder une copie complète synchronisée ou Personnalisé pour choisir vous-même les événements.
5. Cliquez sur Ajouter un webhook.

Vous ne recevez des événements que pour les données que vous êtes autorisé à voir.

Quotas et limites de débit

Les limites s'appliquent par clé API :

• Jusqu'à 30 000 requêtes par mois.
• 10 requêtes par seconde, avec une pointe pouvant aller jusqu'à 50 requêtes.

Si votre intégration a besoin de plus, écrivez à developers@vacationtracker.io en indiquant le nom de votre entreprise, l'intégration et le trafic que vous prévoyez.

Questions fréquentes