Indietro

Crea chiavi API per l'Factorial IT API

Una Factorial IT API key autentica le chiamate che fai all' Factorial IT API, un'API REST. Creane una quando desideri un'integrazione o uno script per leggere o modificare i tuoi dati tramite l'API.


 

Funzionalità

Panoramica

Le chiavi autenticano le richieste all' Factorial IT API (REST). Ci sono due tipi, ognuno con il proprio ambito:

  • Chiave API aziendale. Limitata a un'azienda. Apre ogni endpoint che funziona su risorse a livello aziendale: dispositivi, dipendenti, accessori, ticket, SaaS e altro.
  • Chiave API workspace. Copre l'intero workspace. Apre gli endpoint a livello di workspace, ad esempio per elencare e visualizzare le aziende nel tuo workspace.

La maggior parte degli endpoint richiede una Chiave API aziendale. Solo gli endpoint del workspace (sotto /workspace/) richiedono una Chiave API workspace. La documentazione API mostra un badge su ogni endpoint con il tipo che si aspetta.

 

Come usare: creare una Chiave API aziendale

  1. Vai su Impostazioni > Sviluppatori.
  2. Clicca su Crea chiave.
  3. Digita un Nome chiave di 4 caratteri o più, ad esempio "La mia integrazione".
  4. Imposta il Livello di accesso su Solo lettura o Scrittura/lettura.
  5. Se vuoi, imposta una Scadenza (giorni). Lascialo vuoto per una chiave che non scade mai.
  6. Clicca su Crea chiave, poi su Copia segreto. Il segreto viene mostrato solo questa volta.

Conserva la chiave in un luogo sicuro. Chiunque la possieda può accedere ai tuoi dati tramite l'API.

 

Usa la chiave

Invia la chiave nell'intestazione Authorization di ogni richiesta:

curl https://api.getFactorial IT.com/v1/devices \
  -H "Authorization: Bearer YOUR_API_KEY"

 

Revoca una chiave

  1. Vai su Impostazioni > Sviluppatori e trova la chiave sotto Factorial IT API keys.
  2. Apri il menu ⋯ sulla sua riga e clicca su Revoca.
  3. Conferma.

La chiave smette di funzionare immediatamente e non può essere ripristinata. Le chiavi revocate rimangono nell'elenco così puoi tracciarle. Per rimuoverne una definitivamente, apri il suo menu ⋯ e clicca su Elimina.

 

Visualizza i log API

Dopo che la tua azienda ha inviato la sua prima richiesta, una scheda Vedi log API appare nella scheda Sviluppatori. Cliccaci sopra per aprire i log API. La pagina elenca le ultime 50 richieste REST e MCP per la tua azienda. La colonna Attore mostra la chiave, il client MCP o il dipendente dietro ciascuna di esse.


 

Consigli e migliori pratiche

  • Scegli Solo lettura a meno che l'integrazione non debba scrivere. Assegna a ciascuna chiave il livello di accesso più basso che funziona.
  • Imposta una scadenza per integrazioni temporanee. Una chiave che non scade mai rimane un rischio fino a quando qualcuno non la revoca.
  • Copia subito il segreto. Non verrà mostrato di nuovo.
  • Usa una chiave per integrazione. Un nome chiaro ti dice cosa smette di funzionare quando la revoci.
  • Controlla i log API. La colonna Attore mostra chi sta chiamando l'API.

 

Risoluzione dei problemi e FAQ

Risoluzione dei problemi

  • Un endpoint del workspace rifiuta la tua chiave. Gli endpoint sotto /workspace/ necessitano di una Chiave API workspace, non di una Chiave API aziendale.
  • Un endpoint aziendale rifiuta la tua chiave. La maggior parte degli endpoint richiede una Chiave API aziendale. Controlla il badge sull'endpoint nella documentazione API.
  • Una richiesta di scrittura fallisce. La chiave potrebbe essere Solo lettura. Crea una chiave con accesso Scrittura/lettura.
  • Un'integrazione ha smesso di funzionare. La chiave potrebbe essere stata revocata o ha raggiunto la sua scadenza. Crea una nuova chiave.
  • Non vedi la scheda Vedi log API. Appare solo dopo che la tua azienda ha effettuato almeno una richiesta.

 

FAQ

  1. Posso vedere di nuovo il segreto dopo aver creato la chiave?
    No. Viene mostrato solo una volta. Se lo perdi, crea una nuova chiave.
     
  2. Posso ripristinare una chiave revocata?
    No. Smette di funzionare immediatamente e non può essere ripristinata.
     
  3. Perché le chiavi revocate sono ancora elencate?
    Per tracciabilità. Usa Elimina nel menu ⋯ per rimuoverne una permanentemente.
     
  4. Quante richieste mostrano i log API?
    Le 50 richieste REST e MCP più recenti per la tua azienda.

Questo articolo è stato utile?

Give feedback about this article

Non trovi quello che stai cercando?

Il nostro team di assistenza clienti è qui per te.

Contattaci

Knowledge Base Software powered by Helpjuice