Portale per sviluppatori

Portale per sviluppatori#

L”API pubblica di Shiftavo è un’API REST da macchina a macchina. Un programma si autentica come azienda — non come persona — così una sincronizzazione notturna dei salari gira senza che nessuno resti connesso.

Apri la referenza API →

Suggerimento

Ogni risorsa, campo, metodo, scope ed errore è generato dall’API stessa. La referenza si basa su un documento OpenAPI 3.0 all’indirizzo https://docs.shiftavo.com/api/openapi.json, che puoi passare a qualsiasi generatore di client. Anche ogni shard serve lo schema della versione che sta eseguendo, all’indirizzo {api_base}/api/public/schema/.

Cosa puoi costruire#

  • Leggere i piani dei turni, i dipendenti, i rapporti delle ore, le richieste e i saldi delle assenze, le disponibilità, le regole di lavoro e il costo del personale.

  • Scrivere turni e assegnazioni, disponibilità, correzioni dei rapporti delle ore, decisioni sulle assenze e la configurazione dell’azienda, come sedi, posizioni e tipi di contratto.

  • Iscriverti ai webhook, così le modifiche ti raggiungono nel momento in cui accadono invece di interrogare ciclicamente l’API.

CRUD completo, non un export in sola lettura: POST per creare, PATCH per aggiornare, DELETE per rimuovere e POST verso un sotto-percorso di azione per le transizioni del ciclo di vita.

Cosa non può fare, deliberatamente#

  • Accedere come una persona. Sono accettate solo le credenziali di integrazione; l’accesso personale di un dipendente non funziona.

  • Raggiungere un’altra azienda. Un set di credenziali è vincolato lato server a una sola azienda.

  • Leggere i piani non pubblicati. Le bozze dei turni restano invisibili finché non può vederle anche il team.

  • Prendere o attribuire offerte del mercato. I turni aperti e gli scambi sono in sola lettura qui — quelle decisioni restano alle persone.

Primi passi#

La forma di un’integrazione#

  1. Chiedici le credenziali (vedi Avvio rapido). Ricevi un client ID, un client secret e un insieme di scope.

  2. Scambiali presso il provider di identità con un access token di breve durata.

  3. Leggi il claim api_base da quel token: indica l’host da chiamare. Non scrivere mai un host dei dati direttamente nel codice.

  4. Chiama {api_base}/api/public/v1/… con Authorization: Bearer <token>.

Assistenza#

Qualcosa non è chiaro, o ti serve un endpoint che non c’è? Scrivi a support@shiftavo.com e includi l”X-Request-Id della risposta di cui parli — ogni risposta ne porta uno.