Back

Crea claus API per a l'Factorial IT API

Una Factorial IT API key autentica les trucades que fas a la Factorial IT API, una API REST. Crea'n una quan vulguis una integració o script per llegir o canviar les teves dades a través de l'API.


 

Funcionalitat

Visió general

Les clau autentiquen les sol·licituds a l'Factorial IT API (REST). Hi ha dos tipus, cadascun amb el seu propi abast:

  • Clau API d'empresa. Limitada a una sola empresa. Obre cada punt final que treballa amb recursos a nivell d'empresa: dispositius, empleats/es, accessoris, tiquets, SaaS i més.
  • Clau API d'espai de treball. Cobreix tot el teu espai de treball. Obre els punts finals a nivell d'espai de treball, per exemple, llistant i veient les empreses del teu espai de treball.

La majoria de punts finals necessiten una Clau API d'empresa. Només els punts finals de l'espai de treball (sota /workspace/) necessiten una Clau API d'espai de treball. La referència de l'API mostra un distintiu a cada punt final amb el tipus que espera.

 

Com utilitzar: crea una Clau API d'empresa

  1. Vés a Configuració > Desenvolupadors.
  2. Fes clic a Crea clau.
  3. Escriu un Nom de clau de 4 caràcters o més, per exemple, "La meva integració".
  4. Estableix el Nivell d'accés a Només lectura o Lectura/escriptura.
  5. Si ho desitges, estableix una Expiració (dies). Deixa-ho en blanc per una clau que mai expiri.
  6. Fes clic a Crea clau, després a Copia secret. El secret només es mostra aquesta vegada.

Manten la clau en un lloc segur. Qualsevol persona que la tingui pot accedir a les teves dades a través de l'API.

 

Utilitza la clau

Envia la clau a l'encapçalament Authorization de cada sol·licitud:

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

 

Revoca una clau

  1. Vés a Configuració > Desenvolupadors i troba la clau sota Factorial IT API keys.
  2. Obre el menú ⋯ a la seva fila i fes clic a Revoca.
  3. Confirma.

La clau deixa de funcionar immediatament i no es pot recuperar. Les claus revocades romanen a la llista perquè puguis rastrejar-les. Per eliminar-ne una de manera definitiva, obre el seu menú ⋯ i fes clic a Eliminar.

 

Veure els registres de l'API

Després que la teva empresa hagi enviat la seva primera sol·licitud, apareix una targeta Veure els registres de l'API a la pestanya Desenvolupadors. Fes clic a ella per obrir els registres de l'API. La pàgina llista les últimes 50 sol·licituds REST i MCP per a la teva empresa. La columna Actor mostra la clau, client MCP o empleat/da darrere de cada una.


 

Consells i Millors Pràctiques

  • Tria Només lectura a menys que la integració hagi de escriure. Dona a cada clau el nivell d'accés més baix que funcioni.
  • Estableix una expiració per a integracions temporals. Una clau que mai expira continua sent un risc fins que algú la revoca.
  • Copia el secret immediatament. No es mostrarà de nou.
  • Utilitza una clau per integració. Un nom clar et diu què deixa de funcionar quan la revocas.
  • Comprova els registres de l'API. La columna Actor mostra qui està cridant l'API.

 

Resolució de problemes i FAQ

Resolució de problemes

  • Un punt final d'espai de treball rebutja la teva clau. Els punts finals sota /workspace/ necessiten una Clau API d'espai de treball, no una Clau API d'empresa.
  • Un punt final d'empresa rebutja la teva clau. La majoria de punts finals necessiten una Clau API d'empresa. Comprova el distintiu al punt final a la referència de l'API.
  • Una sol·licitud d'escriptura falla. La clau pot ser Només lectura. Crea una clau amb accés Lectura/escriptura.
  • Una integració ha deixat de funcionar. La clau pot haver estat revocada o haver arribat a la seva expiració. Crea una nova clau.
  • No veus la targeta Veure els registres de l'API. Només apareix un cop la teva empresa ha realitzat almenys una sol·licitud.

 

FAQ

  1. Puc veure el secret de nou després de crear la clau?
    No. Es mostra només una vegada. Si el perds, crea una nova clau.
     
  2. Puc restaurar una clau revocada?
    No. Deixa de funcionar immediatament i no es pot restaurar.
     
  3. Per què les claus revocades encara estan llistades?
    Per traçabilitat. Utilitza Eliminar al menú ⋯ per eliminar-ne una de manera permanent.
     
  4. Quantes sol·licituds mostren els registres de l'API?
    Les 50 sol·licituds REST i MCP més recents per a la teva empresa.

Was this article helpful?

Give feedback about this article

Can’t find what you’re looking for?

Our customer care team is here for you.

Contact us

Knowledge Base Software powered by Helpjuice