Integrazioni software tramite API

 

In questo articolo, approfondiremo gli argomenti seguenti:

  1. Documentazione API interattiva
  2. Gestire i propri token di accesso
  3. Gestire i Webhook per il tuo account
  4. Concedere gli utenti l’autorizzazione per accedere alle funzionalità API

 

Integrazioni software tramite API

PlanRadar fornisce un API web (Application Programming Interface) e Webhook. Questo consente di integrare il software di terzi o un software personalizzato con il proprio account PlanRadar.

L’utilizzo delle API richiede conoscenze nel campo dello sviluppo software. Coinvolgi un team di sviluppo software quando accedi e configuri l’API. Purtroppo, PlanRadar non è in grado di fornire uno sviluppo software personalizzato per conto dei nostri clienti.

 

Documentazione API interattiva

Prima di procedere, assicurati di avere le autorizzazioni per accedere alle funzionalità API. Puoi accedere alla documentazione API tramite Impostazioni > Documentazione API:

 

Puoi provare direttamente tutti gli endpoint. Per alcuni endpoint, è necessario specificare un ID del ticket o del progetto che puoi solitamente trovare e copiare dall’URL quando visualizzi il progetto o il ticket specifico.

Potrai anche copiare e incollare un comando cURL e testare l’API sulla shell di comandi. Tuttavia, avrai bisogno di un token di accesso, di cui parleremo nella sezione successiva.

 

Gestire i propri token di accesso

Utilizza i token di accesso personali per consentire al software esterno di autenticarsi con i nostri server quando si utilizza un API.

Prima di procedere, assicurati di avere le autorizzazioni per accedere alle funzionalità API. Per creare e gestire i token di accesso personali tramite Impostazioni > Profilo > Token di accesso personali.

 

I token sono personali. Non andrebbero condivisi ed è opportuno trattarli con cura. Chiunque possieda un token di accesso potrebbe potenzialmente accedere al tuo account e agire a tuo nome.

 

Per impostazione predefinita, esiste un limite di velocità massimo di 30 richieste al minuto. Il limite si può incrementare su richiesta, contattando [email protected].
 

Gestire i Webhook per il tuo account

I Webhook consentono ai software esterni di reagire a ciò che accade all’interno di PlanRadar, come “ticket creato”, “ticket aggiornato”, “foto allegata”, ecc. Puoi creare e gestire i Webhook tramite Impostazioni > Account > Webhook.

Queste impostazioni sono visibili solo ai proprietari degli account.

 

Fai clic su “Aggiungi un nuovo Webhook”. Qui potrai scegliere gli eventi su cui il software esterno vuole ricevere delle notifiche.

 

Autenticazione:
Qui puoi configurare il modo in cui possiamo autenticarci con il tuo server. Al momento supportiamo l’autenticazione di base HTTP con nome utente e password.

 

Intestazioni:
 Se desideri fornire campi aggiuntivi per le intestazioni per il tuo servizio, puoi configurarle qui. Per password o segreti, consentiamo di nascondere il valore nell’interfaccia utente. Se decidi di nasconderlo, non puoi richiamarlo nell’interfaccia utente dopo aver salvato il Webhook per ragioni di sicurezza.

 

Concedere ai tuoi utenti l’autorizzazione per accedere alle funzionalità API

Si può accedere alla documentazione API e alle pagine relative ai token di accesso personali solo con le autorizzazioni corrette. I proprietari degli account avranno automaticamente accesso alla documentazione API.

Per concedere l’autorizzazione agli altri utenti interni, occorre andare in Gestione utenti > Utenti e modificare o creare un nuovo utente interno e contrassegnare l’autorizzazione ‘Accesso API’.

 

Invalidare i token di accesso degli altri utenti

Hai la possibilità di rimuovere i token di accesso creati da altri utenti interni. Per eliminare i token di accesso, devi avere l’autorizzazione a gestire gli utenti.

Per rimuovere un token di accesso creato da un utente, vai in Gestione utenti > Utenti tramite la barra di navigazione. Da qui, seleziona l’utente interno di cui desideri rimuovere il token dal sistema. Vedrai i token creati dagli utenti a destra, e da qui puoi eliminarli.

 

Nota: gli altri utenti non possono eliminare i token di accesso creati dal proprietario dell’account. Solo il proprietario dell’account può eliminare i propri token di accesso andando in Impostazioni > Profilo > Token di accesso personale.

Torna al  Sommario.