Questo articolo spiega come generare e gestire (aggiornare, disattivare, riattivare e rimuovere) l'API dei report personalizzati in Personio.

Che cos'è un'API per i report personalizzati?

Le API consentono lo scambio di dati tra Personio e un altro servizio o strumento.

L'API per i report personalizzati, in particolare, ti consente di creare analisi e report più avanzati. Ti sarà possibile, ad esempio, unire i dati HR di Personio con altri set di dati, archiviarli in un dataware house ed elaborarli ulteriormente in una applicazione di business intelligence (BI).

A seconda dell'endpoint, questa API ti consente di:

• • • • • recuperare un elenco di tutti i report personalizzati esistenti nell'account Personio;
        • recuperare un elenco di tutte le colonne esistenti della tabella del report; 
        • recuperare i dati di un particolare report personalizzato in formato JSON.

Nota
Attualmente, l'API per i Report personalizzati non consente di creare o modificare un report personalizzato esistente.

Generare credenziali API

1. 1. Accedi a Impostazioni > Integrazioni > Credenziali API.
   2. Fai clic su Genera nuova credenziale.
   3. Verrà visualizzata la barra laterale Aggiungi nuova credenziale. Nel campo Nome, inserisci un nome significativo (ad esempio, Credenziali dei report personalizzati) per le credenziali API.
   4. Se applicabile, seleziona un'integrazione dal menu a discesa Integrazioni. In caso contrario, seleziona Altro.
   5. Seleziona la casella di controllo Leggi per Report personalizzati.
   6. Fai clic su Genera nuova credenziale.
   7. Verrà visualizzato un messaggio di conferma della creazione delle nuove credenziali API.

   

   Suggerimento
   In alternativa, puoi attivare l'endpoint di lettura dei report personalizzati per una credenziale API esistente. Accedi a Impostazioni > Integrazioni > Credenziali API, fai clic su una credenziale e seleziona la casella di controllo Report personalizzato.
   

   Nota
   Tutti i report esistenti possono essere recuperati se l'endpoint di lettura è abilitato. Inoltre, gli attributi dei dipendenti leggibili per la sezione API dei dati del personale non saranno considerati per l'endpoint Report personalizzati. Tutti gli attributi aggiunti a un report personalizzato saranno recuperabili tramite l'endpoint se questo è abilitato per le rispettive credenziali, indipendentemente dal fatto che l'attributo sia stato inserito o meno nella whitelist. 

    

   Gestire le credenziali API 

   Aggiornare le credenziali API

   Per aggiornare il nome delle credenziali API per i report personalizzati, procedi come segue:

   1. 1. Accedi a Impostazioni > Integrazioni > Credenziali API.
      2. Fai clic sulle credenziali API per i report personalizzati.
      3. Nella barra laterale Aggiungi nuova credenziale, apporta le modifiche necessarie.
      4. Fai clic sul pulsante Salva per applicare gli aggiornamenti.
      5. Le credenziali appariranno con il nuovo nome.

   
   
   Disattivare le credenziali API 

   Se desideri interrompere solo temporaneamente il funzionamento delle credenziali, procedi come segue:

   1. 1. Accedi a Impostazioni > Integrazioni > Credenziali API.
      2. Nell'elenco delle credenziali API esistenti, disattiva l'interruttore accanto alle credenziali API per i report personalizzati.
      3. Le credenziali saranno disattivate e lo scambio di dati cesserà finché le credenziali API non verranno riattivate.

    

   Riattivare le credenziali API

   Per riattivare le credenziali API che sono state temporaneamente disattivate, procedi come segue:

   1. 1. Accedi a Impostazioni > Integrazioni > Credenziali API.
      2. Nell'elenco delle credenziali API esistenti, attiva l'interruttore accanto alle credenziali API per i report personalizzati.
      3. Le credenziali verranno riattivate e lo scambio di dati riprenderà.

   
   
   Rimuovere le credenziali API

   Per eliminare in modo permanente e bloccare il funzionamento delle credenziali API, segui questi passaggi:

   1. 1. Accedi a Impostazioni > Integrazioni > Credenziali API.
      2. Fai clic sulle credenziali API per i report personalizzati.
      3. Nella barra laterale Aggiungi nuova credenziale, fai clic sull'icona Cestino e conferma di voler rimuovere le credenziali API.
      4. Le credenziali verranno rimosse in modo permanente. 

    

   Documentazione tecnica

   Tutta la documentazione relativa all'API per i report personalizzati, compresi gli endpoint, le informazioni sui dati trasferiti e i tutorial tecnici, è disponibile nel nostro Hub per sviluppatori.