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, ons te contacteren via support@azumuta.com - we helpen u graag.
Onze REST API maakt gebruik van standaard HTTP-antwoordcodes en werkwoorden. Bij het indienen van een normale GET-verzoek worden de gegevens geretourneerd als JSON-gecodeerde antwoorden.
Authenticatie
De Azumuta API gebruikt API-sleutels voor authenticatie van verzoeken. Verzenden de sleutel in de X-API-Key request header (aanbevolen). U kunt ook een apiKey query parameter gebruiken.
Creëren en beheer sleutels onder Management → Devices → API. Zie Creëren en beheer API-sleutels.
Alle API-verzoeken moeten via HTTPS worden ingediend. Oproepen via gewone HTTP mislukken. API-verzoeken zonder authenticatie mislukken ook.
Opmerking: Uw API-sleutels zijn topgeheim informatie die nooit met iemand buiten uw bedrijf mag worden gedeeld en mag nooit in browsercode verschijnen.
Toegang tot API-documentatie
De Azumuta REST API is gedocumenteerd in onze in-app API documentatie:
- Klik op het vraagteken in de rechterbovenhoek van uw scherm (Help).
- Klik op API documentatie.
Dat opent de interactieve referentie op /docs/api in het Azumuta Platform. Daar kunt u eindpunten voor Azumuta Modules en Add-ons bladeren (behalve Dashboards).
Wanneer u bent geverifieerd, kunt u eindpunten live testen met de Try it out knop en het resultaat in uw Azumuta Platform zien.
Workspace AI Primer voor Developers
Als u een integratie met een AI-codeeringsassistent bouwt, begin dan met de workspace-aangepaste primer in plaats van het volledige OpenAPI-document in uw kennisbank te plakken.
Geverifieerde GET /api/v1/agents-azumuta.md retourneert een markdown-bestand voor uw workspace (basis-URL, Talen en API-conventies). Download het van de introductie van de in-app API documentatie, of verzoek dat pad met uw API-sleutel.
De machine-leesbare OpenAPI-specificatie is beschikbaar op /api/v1/spec.json (vereist ook uw API-sleutel), of via de Swagger UI in de API documentatie.
MCP voor AI-assistenten (beta)
Beta Feature. Azumuta's MCP (Model Context Protocol) server stelt AI-assistenten in staat om toegestane REST-gereedschap voor uw workspace aan te roepen. Het is in Beta, kan nog evolueren en is enkel beschikbaar op opt-in basis. Om MCP in te schakelen of vragen te stellen, contacteer support@azumuta.com.
MCP-toegang vereist het workspace MCP-experiment en een API-sleutel met expliciete scopes. Geef de voorkeur aan de workspace AI primer en in-app API documentatie voor eindpuntconventies; plak het volledige OpenAPI-document niet in een gedeelde kennisbank.
Roep de API aan vanuit Server-Side Integraties
Roep de Azumuta REST API enkel aan vanuit server-side integraties. Bewaar de API-sleutel op uw server of integratielaag - niet in operator-browsers of ander client-side code.