Azumuta's REST-API
Opmerking: Dit is een hoogst technisch artikel. We raden aan uw IT-afdeling te betrekken bij het lezen. Als u vragen of verzoeken heeft, neem dan contact met ons op via support@azumuta.com - we helpen u graag.
Onze REST-API gebruikt standaard HTTP-responscodes en HTTP-methoden. Bij een normale GET-aanvraag worden de gegevens geretourneerd als JSON-gecodeerde respons.
Authenticatie
De Azumuta API gebruikt API-sleutels om verzoeken te authenticeren. Stuur de sleutel in de X-API-Key request header (aanbevolen). U kunt ook de queryparameter apiKey gebruiken.
Maak en beheer sleutels onder Management → Devices → API. Zie API-sleutels aanmaken en beheren.
Alle API-verzoeken moeten via HTTPS worden gedaan. Oproepen via gewoon HTTP zullen mislukken. API-verzoeken zonder authenticatie zullen ook mislukken.
Opmerking: Uw API-sleutels zijn uiterst vertrouwelijke informatie die nooit gedeeld mogen worden met personen buiten uw bedrijf en nooit in browserclientcode mogen verschijnen.
Toegang tot API-documentatie
De Azumuta REST API is gedocumenteerd in onze in-app API-docs:
- Klik op het vraagteken rechtsboven in uw scherm (Help).
- Klik op API docs.
Dat opent de interactieve referentie op /docs/api in het Azumuta-platform. Daar kunt u endpoints voor Azumuta-modules en add-ons doorzoeken (behalve Dashboards).
Als u geauthenticeerd bent, kunt u endpoints live testen met de knop Try it out en het resultaat in uw Azumuta-platform bekijken.
Workspace AI-primer voor ontwikkelaars
Als u een integratie bouwt met een AI-codeassistent, begin dan met de op workspace afgestemde primer in plaats van het volledige OpenAPI-document in uw kennisbank te plakken.
Geauthenticeerde GET /api/v1/agents-azumuta.md retourneert een markdownbestand voor uw workspace (basis-URL, talen en API-conventies). Download het vanuit de in-app API-docs introductie, of vraag dat pad op met uw API-sleutel.
De machineleesbare OpenAPI-specificatie is beschikbaar op /api/v1/spec.json (vereist ook uw API-sleutel), of via de Swagger UI in de API-docs.
MCP voor AI-assistenten (beta)
Bèta-functie. De MCP (Model Context Protocol)-server van Azumuta stelt AI-assistenten in staat toegestane REST-tools voor uw workspace aan te roepen. Het bevindt zich in beta, kan nog evolueren en is alleen beschikbaar op basis van opt-in. Om MCP in te schakelen of vragen te stellen, neem contact op met support@azumuta.com.
Toegang tot MCP vereist het workspace MCP-experiment en een API-sleutel met expliciete scopes. Gebruik bij voorkeur de workspace AI-primer en de in-app API-docs voor endpointconventies; plak het volledige OpenAPI-document niet in een gedeelde kennisbank.
De API aanroepen vanuit server-side-integraties
Roep de Azumuta REST API alleen aan vanuit server-side integraties. Bewaar de API-sleutel op uw server of integratielaag — niet in operatorbrowsers of andere client-side code.