Opmerking: Dit is een zeer technisch artikel. Daarom raden we u 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 keys authenticeren verzoeken aan Azumuta's REST API. Elke key behoort tot een API Device in uw Workspace. U beheert deze Devices op de API Devices pagina.
How to Create an API Key
- Ga naar Management → Devices → API tabblad. De paginatitel is API Devices.
- Klik Device toevoegen.
- Voer een Naam in, stel Type in op Api Device, en klik vervolgens voeg toe.
Azumuta maakt het Device aan en genereert een API Key ervoor.
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.
How to Copy an API Key
U kunt een Key op een van deze manieren kopiëren:
- In de API Devices lijst opent u het rijmenu voor het Device en klikt u Kopieer API sleutel. Een snackbar toont Gekopieerd.
- Of klik Device bewerken, zoek API attributen, en gebruik vervolgens het kopieerpictogram naast het API Key veld.
How to Authenticate API Requests
Verzend de Key in de X-API-Key request header. Dit is de aanbevolen methode.
U kunt de Key ook doorgeven als een apiKey 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 Key mislukken ook.
Belangrijk: Plaats nooit een API Key in browser client code, openbare repositories, of ergens buiten uw bedrijf. Behandel Keys als geheime inloggegevens enkel voor server-side Integraties.
Optional: API Scopes
API Keys zijn environment-scoped. Een Key die op uw sandbox host is aangemaakt, werkt enkel tegen die sandbox omgeving. Een Productie Key werkt enkel tegen Productie. Het gebruik van een sandbox Key tegen Productie (of omgekeerd) retourneert een Authenticatie fout.
Optional: API Scopes
Als het API scopes experiment is ingeschakeld voor uw Workspace, kunt u beperken wat een Key mag doen. Open Device bewerken → Veiligheid, en configureer vervolgens API scopes. Wanneer deze optie niet beschikbaar is voor uw Workspace, heeft de Key de standaard toegang voor een API Device.