Maak en beheer API-sleutels

Bijgewerkt

Opmerking: Dit artikel is technisch; we raden aan iemand met de juiste technische expertise te betrekken. Als u vragen heeft, neem dan contact met ons op via support@azumuta.com.

API-sleutels verifiëren verzoeken aan de REST API van Azumuta. Elke sleutel behoort tot een API device in uw workspace. U beheert die apparaten op de API Devices-pagina.

Create an API key

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

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

Voor meer informatie over de Devices-pagina's in het algemeen, zie See the list of devices that are logged in on your workspace.

Een API-sleutel kopiëren

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

  • Op de lijst API Devices, open het rijmenu voor het apparaat en klik 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 doorgeven als queryparameter apiKey. Geef de voorkeur aan de header wanneer mogelijk.

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

Important: Plaats een API-sleutel nooit in clientcode in de browser, openbare repositories of ergens buiten uw bedrijf. Behandel sleutels als geheime referenties en alleen voor server-side-integraties.

Environment Scope

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

Optioneel: API Scopes

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

Op deze pagina