Opmerking: Dit artikel is technisch van aard, dus we raden aan iemand met de juiste technische expertise erbij te betrekken. Als u vragen heeft, kunt u ons te contacteren.
API-sleutels authenticeren 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 maken
- 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:
- Op de API Devices lijst, opent u het rijmenu voor het apparaat en klikt u op Kopieer API sleutel. Een snackbar toont Gekopieerd.
- Of klik op Device bewerken, zoek API attributen, en gebruik het kopieerpictogram naast het Key veld.
API-verzoeken authenticeren
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 dit 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 browser client code, openbare repositories, of op een plaats buiten uw bedrijf. Behandel sleutels als geheime referenties enkel voor server-side Integraties.
Environment Scope
API-sleutels zijn environment-scoped. Een sleutel die is aangemaakt op uw sandbox host 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 Authenticatie fout.
Optioneel: API scopes
Als het API scopes experiment is ingeschakeld voor uw Workspace, 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.