Come usare l'API aperta (OpenAPI)?

Il nostro componente aggiuntivo API aperta collega Vacation Tracker ai tuoi strumenti. Crea una chiave API, scegli cosa può fare e usala per leggere e modificare i tuoi dati o per ricevere una notifica quando qualcosa cambia.

Come creare una chiave API

1. Accedi al tuo account Vacation Tracker su app.vacationtracker.io/signin.
2. Apri Integrazioni dal menu a sinistra (in Impostazioni spazio di lavoro).
3. Fai clic sulla scheda API. Si apre la pagina API aperta.
4. Nella sezione Chiavi API, fai clic su Crea chiave API.
5. Inserisci un Nome della chiave. Questo nome è visibile solo alle persone della tua azienda.
6. Facoltativamente, inserisci un Nome dell'integrazione. Le persone lo vedono in Vacation Tracker accanto a ogni modifica effettuata dalla chiave, ad esempio “Approvato da Jane (tramite Payroll sync)”. Lascialo vuoto per mostrare solo il nome della persona.
7. In Permessi, scegli un modello e modificalo se necessario (vedi sotto).
8. In Scadenza, scegli quando scade la chiave: tra 30 giorni, tra 90 giorni, tra 1 anno (consigliato) o mai.
9. Controlla il Riepilogo e fai clic su Crea chiave API.
10. Copia la chiave e conservala in un luogo sicuro. La chiave completa viene mostrata una sola volta, al momento della creazione.

Scegliere i permessi

Parti da un modello, poi adattalo:

• Sola lettura: vede i dati, non modifica nulla. Adatto a rapporti e dashboard.
• Gestione dei congedi: richiede, aggiunge e approva congedi. Legge utenti e tipi di congedo.
• Configurazione dello spazio di lavoro: configura sedi, dipartimenti, tipi di congedo, politiche, festività e utenti.
• Personalizzato: scegli tu ogni singolo permesso.

Ogni permesso può essere impostato su Nessun accesso, Lettura o Lettura e scrittura. Approvare e rifiutare richieste, vedere i nomi dei tipi di congedo nascosti e agire per conto di altri utenti sono caselle di controllo separate, quindi attivale solo se il tuo strumento ne ha bisogno. Una chiave può fare solo ciò che tu puoi fare in Vacation Tracker.

Gestire le chiavi

La tabella Chiavi API elenca tutte le chiavi del tuo spazio di lavoro con proprietario, permessi, ultimo utilizzo, data di scadenza e stato. Fai clic su una chiave per aprirne i dettagli, dove puoi:

• Vedere l'utilizzo di questo mese e modificare il nome e i permessi della chiave.
• Controllare l'Attività recente, che elenca ogni richiesta che ha modificato dati.
• Fare clic su Ruota chiave per ottenere una nuova chiave con lo stesso nome e gli stessi permessi. Scegli se la vecchia chiave continua a funzionare per 24 ore (consigliato), per 7 giorni o smette subito di funzionare.
• Fare clic su Revoca per disattivare la chiave definitivamente.

Ti inviamo un'email 14 giorni prima della scadenza di una chiave.

Effettuare la prima richiesta

L'URL di base è https://api.vacationtracker.io/v2. Invia la tua chiave come bearer token nell'header Authorization:

Una chiamata riuscita restituisce i dati in data. Gli elenchi con più pagine includono anche un nextToken, da ripassare per ottenere la pagina successiva.

Se qualcosa va storto, la risposta include un error con un codice, una descrizione e una soluzione. Una chiave mancante o sconosciuta restituisce 401. Una chiave senza il permesso richiesto da una richiesta restituisce 403 con INSUFFICIENT_SCOPE.

Come aggiungere un webhook

1. Nella pagina del componente aggiuntivo API aperta, vai a Webhook e fai clic su Gestisci webhook.
2. Fai clic su Aggiungi webhook.
3. Inserisci l'URL dell'endpoint che deve ricevere gli eventi. Deve usare HTTPS.
4. In Eventi, scegli Decisioni sui congedi, Tutte le attività sulle assenze, Mantieni una copia completa sincronizzata oppure Personalizzato per scegliere tu gli eventi.
5. Fai clic su Aggiungi webhook.

Ricevi eventi solo per i dati che hai il permesso di vedere.

Quote e limiti di frequenza

I limiti si applicano per singola chiave API:

• Fino a 30.000 richieste al mese.
• 10 richieste al secondo, con picchi fino a 50 richieste.

Se la tua integrazione ha bisogno di più richieste, scrivi a developers@vacationtracker.io indicando il nome della tua azienda, l'integrazione e il traffico previsto.

Domande frequenti