REST-API van Azumuta

Bijgewerkt

Opmerking: Dit is een zeer technisch artikel. Wij raden u aan uw IT‑afdeling 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.

Onze REST API gebruikt standaard HTTP-responscodes en -verben. Bij een normale GET-aanvraag worden de gegevens geretourneerd als JSON-gecodeerde antwoorden.

Authenticatie

De Azumuta API gebruikt API-sleutels om verzoeken te authenticeren. Verstuur de sleutel in de requestheader X-API-Key (aanbevolen). U kunt ook een apiKey queryparameter gebruiken.

Maak en beheer sleutels onder ManagementDevicesAPI. Zie Hoe API-sleutels te maken en beheren.

Alle API-verzoeken moeten via HTTPS worden gedaan. Oproepen via plain HTTP zullen mislukken. API-verzoeken zonder authenticatie zullen ook mislukken.

Opmerking: Uw API-sleutels zijn strikt vertrouwelijke gegevens die nooit met derden buiten uw organisatie mogen worden gedeeld en nooit in browserclientcode mogen voorkomen.

Toegang tot API-documentatie

De Azumuta REST API is gedocumenteerd in onze in-app API-docs:

  1. Klik op het vraagteken rechtsboven op uw scherm (Help).
  2. Klik op API docs.

Daarmee wordt de interactieve referentie op /docs/api in de Azumuta Platform geopend. 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.

docs hoe toegang te krijgen tot api-documentatie

Workspace AI-primer voor ontwikkelaars

Als u een integratie bouwt met een AI-codeassistent, begin dan met de voor uw 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 (bèta)

Bètafunctie. Azumuta's MCP (Model Context Protocol) server maakt het AI-assistenten mogelijk toegestane REST-tools voor uw workspace aan te roepen. Het is in bèta, kan nog evolueren en is alleen beschikbaar na opt-in. Om MCP in te schakelen of vragen te stellen, neem contact op via 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.

API aanroepen vanuit server-side integraties

Roep de Azumuta REST API uitsluitend aan vanuit server-side integraties. Bewaar de API-sleutel op uw server of integratielaag — niet in operatorbrowsers of andere client-side code.

Gerelateerde artikelen