Opmerking: Dit is een zeer technisch artikel. Daarom raden we aan uw IT-afdeling erbij te betrekken bij het lezen hiervan. Mocht u vragen of verzoeken hebben, neem dan contact met ons op via support@azumuta.com. We helpen u graag.
API-sleutels verifiëren verzoeken aan Azumuta's REST API. Elke sleutel behoort tot een API-apparaat in uw Workspace. U beheert deze apparaten op de pagina API Devices.
Een API-sleutel creëren
- Ga naar Management → Devices → API Tabblad. De paginatitel is API Devices.
- Klik op gele plus → Device toevoegen.
- Voer een Naam in, stel Type in op API-apparaat, en klik vervolgens op voeg toe.
Azumuta maakt het apparaat aan en genereert een API-sleutel ervoor.
Voor meer informatie over de Devices-pagina's in het algemeen, zie Zie de lijst met apparaten die zijn aangemeld in uw Workspace.
Een API-sleutel kopiëren
U kunt een sleutel op een van deze manieren kopiëren:
- Open op de API Devices-lijst het rijmenu voor het apparaat en klik op Kopieer API sleutel. Een snackbar toont Gekopieerd.
- Of klik op Device bewerken, zoek API attributen, en gebruik vervolgens het kopieerpictogram naast het veld Key.
API-verzoeken verifiëren
Verzend de sleutel in de X-API-Key request Header. Dit is de aanbevolen methode.
U kunt de sleutel ook doorgeven als een apiKey query parameter. Geef de voorkeur aan de Header wanneer u dat kunt.
Alle API-verzoeken moeten HTTPS gebruiken. Verzoeken via gewone HTTP mislukken. Verzoeken zonder een geldige sleutel mislukken ook.
Belangrijk: Plaats nooit een API-sleutel in browsercode, openbare repositories of ergens buiten uw bedrijf. Behandel sleutels als geheime inloggegevens enkel voor server-side Integraties.
Environment Scope
API-sleutels zijn environment-scoped. Een sleutel die op uw sandbox-host is aangemaakt, werkt enkel tegen die sandbox-omgeving. Een Productie-sleutel werkt enkel tegen Productie. Het gebruik van een sandbox-sleutel tegen Productie (of omgekeerd) retourneert een verificatiefout.
Optioneel: API scopes
Als het API scopes-experiment voor uw Workspace is ingeschakeld, kunt u beperken wat een sleutel mag doen. Open Device bewerken → Veiligheid, en configureer vervolgens API scopes. Wanneer deze optie niet beschikbaar is voor uw Workspace, heeft de sleutel de standaard Toegang voor een API-apparaat.