API-sleutels aanmaken en beheren

Bijgewerkt

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

API-sleutels authenticeren verzoeken aan Azumuta’s REST API. Elke sleutel hoort bij een API device in uw werkruimte. U beheert die apparaten op de pagina API Devices.

API-sleutel aanmaken

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

Azumuta maakt het apparaat aan en genereert daarvoor een API-sleutel.

Voor meer informatie over de Devices-pagina's in het algemeen, zie Zie de lijst met apparaten die ingelogd zijn op uw werkruimte.

API-sleutel kopiëren

U kunt een sleutel op een van de volgende manieren kopiëren:

  • Op de lijst API Devices opent u het rijenmenu voor het apparaat en klikt u op Copy API key. Er verschijnt een snackbar met Copied.
  • Of klik op Edit device, zoek API attributes, en gebruik vervolgens het kopieericoon naast het veld API key.

API-verzoeken authenticeren

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

U kunt de sleutel ook meegeven als queryparameter apiKey. Gebruik bij voorkeur de header wanneer dat mogelijk is.

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

Belangrijk: Plaats nooit een API-sleutel in client-side browsercode, openbare repositories of ergens buiten uw bedrijf. Behandel sleutels als geheime referenties uitsluitend voor server-side integraties.

Omgevingsbereik

API-sleutels zijn environment-scoped. Een sleutel die op uw sandboxhost is aangemaakt werkt alleen tegen die sandboxomgeving. Een productiesleutel werkt alleen tegen productie. Het gebruik van een sandbox-sleutel tegen productie (of omgekeerd) geeft een authenticatiefout.

Optioneel: API scopes

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