API-nøgleadministration

Følg

API-nøgler

API-nøgler (Adgang → API-nøgler) er legitimationsoplysninger for eksterne systemer, som de bruger til at kalde Gillies API'er. Hver nøgle har sine egne rettigheder, og brugen kan begrænses til teams og tilladte API'er.

Grundlæggende oplysninger

  • Navn — beskrivende navn for nøglen (påkrævet).

Signaturverifikation

  • Kræv checksum — hvis denne indstilling er aktiveret, skal kald indeholde nøglernes checksum (hash). Anbefales til produktionsbrug.

Visning af nøgle

Når nøglen er gemt, vises:

  • API-nøgle — den offentlige identifikator, der sendes med kald.
  • Privat nøgle — vises kun ved oprettelsen. Gem denne sikkert med det samme, da den ikke kan vises igen.

Tilladte teams

  • Tillad alle teams — nøglen får adgang til alle teams.
  • Hvis denne indstilling er deaktiveret, vælg de teams, der skal have adgang, fra listen.

Tilladte API'er

Tilladte API'er-listen indeholder sti eller mønstre for API'er (fx /api/v1/customers). Nøglen kan kun kalde disse API'er.

Rollegruppe og rettigheder

Nøglen tildeles rettigheder på samme måde som en bruger: vælg rollegruppe og de roller, som nøglen skal have.

Yderligere funktioner

  • Audit trail — nøglens ændringshistorik (ret admin_apikeys_audit).
  • Test indlejret — hurtigtest af nøglen direkte fra administrationsvisningen (synlig først efter gemning).
  • Slet — sletter nøglen permanent.

Advarsel. Den private nøgle vises kun én gang. Hvis nøglen glemmes eller kompromitteres, slet den gamle nøgle og opret en ny.

Adgang

Administration kræver rettigheden admin_apikeys.