Azumuta's REST API

Bijgewerkt

Opmerking: Dit artikel is technisch van aard; we raden aan iemand met de juiste technische expertise te betrekken. Als u vragen heeft, neem contact met ons op via support@azumuta.com.

Onze REST API gebruikt standaard HTTP-responscodes en HTTP-methoden. Bij een normale GET-aanvraag wordt de data teruggegeven als JSON-gecodeerde responses.

Authenticatie

De Azumuta API gebruikt API-sleutels om verzoeken te authenticeren. U heeft twee opties:

Header (aanbevolen)

Stuur de sleutel in de X-API-Key request-header.

Parameter

Gebruik de queryparameter apiKey.

Maak en beheer sleutels via Management → Devices → API. Zie Maak en beheer API-sleutels.

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 gevoelige informatie die nooit met personen buiten uw bedrijf gedeeld mogen worden en nooit in client-side browsercode mogen verschijnen.

API-documentatie openen

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

  1. Klik op het vraagteken rechtsboven in uw scherm (Help).
  2. 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).

Wanneer u geauthenticeerd bent, kunt u endpoints live testen met de Try it out-knop en het resultaat in uw Azumuta-platform bekijken.

docs hoe API-documentatie te openen

Workspace AI-inleiding voor ontwikkelaars

Als u een integratie met een AI-codeassistent bouwt, begin dan met de workspace-specifieke inleiding in plaats van het volledige OpenAPI-document in uw kennisbasis te plakken.

Geauthenticeerde GET /api/v1/agents-azumuta.md retourneert een markdownbestand voor uw workspace met de basis-URL, talen en API-conventies. Download het vanuit de in-app API-docsintroductie, of vraag dat pad op met uw API-sleutel.

De machineleesbare OpenAPI-specificatie is beschikbaar op /api/v1/spec.json en vereist ook uw API-sleutel, of via de Swagger UI in de API-docs.

MCP voor AI-assistenten (BETA)

BETA: Azumuta MCP bevindt zich momenteel in beta en kan nog veranderen. Het is alleen beschikbaar op basis van opt-in. Om deel te nemen aan de beta of vragen te stellen, neem contact op met support@azumuta.com.

Model Context Protocol (MCP) stelt uw favoriete AI-assistent in staat om toegestane workspace-data op te halen via geselecteerde read-only tools. Het maakt niet alle REST-operaties beschikbaar. Volg Connect your AI assistant to Azumuta voor de setup, en zie Use Azumuta MCP voor voorbeelden en beperkingen.

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.

Gerelateerde artikelen