Hoe u API-sleutels aanmaakt en beheert

Bijgewerkt

Opmerking: Dit is een zeer technisch artikel. Wij raden u aan uw IT‑afdeling erbij te betrekken bij het lezen. Heeft u vragen of verzoeken, neem dan contact met ons op via support@azumuta.com — wij helpen u graag.

API-sleutels authenticeren verzoeken naar Azumuta’s REST API. Elke sleutel behoort tot een API device in uw workspace. U beheert die devices op de API Devices-pagina.

Hoe u een API-sleutel aanmaakt

  1. Ga naar ManagementDevicesAPI tab. De paginatitel is API Devices.
  2. Klik Add device.
  3. Voer een Name in, zet Type op Api Device, klik vervolgens op Add.

Azumuta maakt het device aan en genereert er een API-sleutel voor.

Voor meer informatie over de Devices-pagina’s in het algemeen, zie How to See the List of Devices That Are Logged in on Your Workspace.

Hoe u een API-sleutel kopieert

U kunt een sleutel op één van deze manieren kopiëren:

  1. Open in de lijst API Devices het rijmenu van het device en klik Copy API key. Er verschijnt een snackbar met Copied.
  2. Of klik Edit device, zoek API attributes, en gebruik het kopieer-icoon naast het API key-veld.

Hoe API-verzoeken te authenticeren

Stuur de sleutel in de request-header X-API-Key. Dat is de aanbevolen methode.

U kunt de sleutel ook meegeven als query-parameter apiKey. Geef de voorkeur aan de header wanneer mogelijk.

Alle API-verzoeken moeten HTTPS gebruiken. Verzoeken via plain HTTP mislukken. Verzoeken zonder geldige sleutel mislukken ook.

Belangrijk: Plaats nooit een API-sleutel in clientcode die in de browser draait, in openbare repositories of op enige andere plaats buiten uw bedrijf. Behandel sleutels alleen als vertrouwelijke gegevens voor server-side-integraties.

Omgevingsscope

API-sleutels zijn environment-scoped. Een sleutel die op uw sandbox-host is aangemaakt werkt alleen tegen die sandbox-omgeving. Een productiesleutel werkt alleen in productie. Het gebruik van een sandbox-sleutel tegen productie (of andersom) levert een authenticatiefout op.

Optioneel: API scopes

Als het experiment API scopes is ingeschakeld voor uw workspace, kunt u beperken wat een sleutel mag doen. Open Edit deviceSecurity, en configureer vervolgens API scopes. Wanneer die optie niet beschikbaar is voor uw workspace, heeft de sleutel de standaardtoegang voor een API device.