operanda Hilfe

Eigene Schnittstelle anbinden

Eine beliebige API mit Schlüssel verbinden, etwa die eigene Warenwirtschaft. Die KI beschreibt sie, du verbindest sie.

Mit deinem operanda-KontoJetzt verbinden

Für viele Systeme gibt es bei operanda einen fertigen Konnektor. Für alle anderen gibt es die eigene Schnittstelle: Hat ein System eine HTTP-API mit Schlüssel, bindest du sie selbst an. Die KI liest dazu die Doku des Anbieters und schreibt eine kurze Beschreibung, welche Aufrufe es gibt und was sie tun. Du fügst die Beschreibung beim Verbinden ein, zusammen mit dem Schlüssel.

Jede angebundene API ist danach ein Konto wie jedes andere: Du entscheidest, welche Projekte sie benutzen und was der Agent dort darf. Andere sehen sie nicht.

Was du vorher brauchst

WerWas
Anbietereine HTTP-API mit Dokumentation und einen API-Schlüssel (oder Benutzer und Passwort)
Duden Schlüssel und die Adresse der Doku
operandaRolle Inhaber oder Verwaltung, wenn das Konto der Firma gehören soll; sonst reicht jedes Mitglied

Die Adresse der API muss mit https:// beginnen und aus dem Internet erreichbar sein. Server im eigenen Firmennetz gehen nicht.

Schritt 1: Beschreibung von der KI schreiben lassen

Öffne einen Chat und schreib zum Beispiel:

Nenn nur, was du wirklich brauchst. Zehn gut beschriebene Aufrufe bringen mehr als hundert, die keiner versteht.

Die Beschreibung sieht so aus:

json { "name": "Warenwirtschaft Müller", "basis": "https://api.example.de/v2", "anmeldung": { "kopf": "Authorization", "vorlage": "Bearer {schluessel}" }, "pruefung": { "pfad": "/me" }, "hinweise": "Kundennummern beginnen mit K-. Datumsangaben als 2026-10-13.", "operationen": [ { "name": "kunden_suchen", "art": "lesen", "methode": "GET", "pfad": "/kunden", "beschreibung": "Sucht Kunden nach Name oder Nummer. Liefert id, Name und Ort.", "query": { "suche": { "type": "string", "description": "Name oder Nummer, etwa Weber", "pflicht": true } } }, { "name": "auftraege_lesen", "art": "lesen", "methode": "GET", "pfad": "/kunden/{id}/auftraege", "beschreibung": "Listet die Aufträge eines Kunden.", "parameter": { "id": "Die Kundennummer aus kunden_suchen, etwa K-1001." } }, { "name": "auftrag_anlegen", "art": "aendern", "methode": "POST", "pfad": "/auftraege", "beschreibung": "Legt einen Auftrag an.", "koerper": { "type": "object", "properties": { "kunde": { "type": "string", "description": "Kundennummer" }, "text": { "type": "string", "description": "Was zu tun ist" } }, "required": ["kunde", "text"] }, "fest": { "koerper": { "status": "neu" } } } ] }

Was die Felder bedeuten:

FeldBedeutung
nameWie die Schnittstelle bei dir heißt. Name und Adresse zusammen machen das Konto aus.
basisDie Adresse, vor die jeder pfad gesetzt wird. Nur https://.
anmeldungIn welcher Kopfzeile der Schlüssel reist. {schluessel} steht für ihn. Ohne Angabe gilt Authorization: Bearer {schluessel}. Für einen Kopf wie X-Api-Key steht dort "kopf": "X-Api-Key", "vorlage": "{schluessel}". Für Benutzer und Passwort "art": "basic".
kopfzeilenFeste Kopfzeilen, die der Anbieter bei jedem Aufruf verlangt, etwa eine Version. Freiwillig.
pruefungEin lesender Aufruf, mit dem operanda den Schlüssel testet. Ohne Angabe die erste lesende Operation ohne Pflichtangaben.
hinweiseWas die KI über die API wissen sollte. Freiwillig, höchstens 2000 Zeichen.
operationenDie Aufrufe, höchstens 40. Nur sie sind erreichbar, sonst nichts.

Je Operation:

FeldBedeutung
nameKleinbuchstaben, Ziffern und _, etwa kunden_suchen.
artlesen, entwurf, aendern, senden oder loeschen. Davon hängt ab, was der Agent damit darf.
methode, pfadWie beim Anbieter. Platzhalter im Pfad stehen in geschweiften Klammern: /kunden/{id}.
beschreibungWas die Operation tut und was zurückkommt, auf Deutsch.
parameterEin Satz je Platzhalter im Pfad.
queryAngaben hinter dem ?, je eine als JSON-Schema. "pflicht": true macht sie zur Pflicht.
koerperDer JSON-Körper als JSON-Schema. Nicht bei GET.
festWerte, die immer gesetzt werden und die die KI nicht ändern kann, unter query oder koerper.

Die Art ist der wichtigste Teil. Sie muss stimmen:

  • lesen: holt nur Daten. Immer ein GET.
  • entwurf: legt etwas an, das noch nicht wirkt, etwa einen Rechnungsentwurf.
  • aendern: legt an oder ändert, und das wirkt sofort.
  • senden: geht nach draußen oder ist endgültig, etwa eine Mail verschicken oder eine Rechnung festschreiben.
  • loeschen: löscht. Ein DELETE ist immer loeschen.

Ein Aufruf, der etwas Endgültiges tut, gehört zu senden, auch wenn er technisch nur ein POST ist. Schau dir diese Stellen an, bevor du verbindest.

Schritt 2: Konto verbinden

  1. Konten, dann Konto verbinden, dann Eigene Schnittstelle.
  2. Wem gehört das Konto?
    • Mir: Nur du entscheidest, welche Projekte es benutzen.
    • Der Firma: Die Leitung entscheidet, und das Konto bleibt, wenn du gehst. Diese Wahl sehen nur Inhaber und Verwaltung.
  3. Die Beschreibung in das große Feld einfügen.
  4. Den Schlüssel eintragen. Bei "art": "basic" dazu den Benutzer.
  5. Verbinden. operanda prüft die Beschreibung und macht einen Probeaufruf mit dem Schlüssel. Erst wenn beides klappt, wird das Konto gespeichert, der Schlüssel verschlüsselt. Passt etwas nicht, nennt die Meldung die Stelle, etwa „operationen[2] (auftrag_anlegen): koerper beschreibt ein Objekt“. Diese Meldung kannst du der KI zurückgeben.
  6. Bei „Wer soll es benutzen?“ die Projekte einschalten.

Ändern geht so: die geänderte Beschreibung mit gleichem name und gleicher basis neu verbinden. Das Konto wird ersetzt, Projekte und Rechte bleiben.

Schritt 3: Recht im Projekt einstellen

StufeWas der Agent darf
LesenOperationen der Art lesen aufrufen
Bearbeitendazu entwurf und aendern
Senden & Löschendazu senden und loeschen

Im Chat sieht der Agent zuerst die Liste der Operationen und ruft sie dann über ein Werkzeug je Art auf. Das Werkzeug für Lesen erreicht keine schreibende Operation, egal wie sie heißt.

Prüfen, ob alles stimmt

Am Konto unter Mehr auf Verbindung prüfen tippen. operanda macht dann den Probeaufruf aus pruefung und ändert nichts. Danach im Chat des Projekts fragen „Was kann unsere Warenwirtschaft?“: Der Agent sollte die Operationen aufzählen.

Was du siehstWoran es liegtWas hilft
„Die Beschreibung ist kein gültiges JSON“beim Kopieren abgeschnitten oder Text um das JSON herumnur den Block von { bis } einfügen
Eine Meldung mit operationen[…]eine Operation passt nicht zu den Regelndie Meldung der KI geben und die Beschreibung korrigieren lassen
„Die Adresse … ist nicht nutzbar“kein https, oder der Server steht im internen Netzeine öffentliche https-Adresse nehmen
„… kennt diesen Schlüssel nicht“Schlüssel falsch, abgelaufen oder in der falschen Kopfzeilebeim Anbieter nachsehen, anmeldung mit der Doku vergleichen
„Die Beschreibung ist zu groß“zu viele Operationen oder sehr lange Texteauf die nötigen Operationen kürzen

Trennen unter Konten, die Schnittstelle öffnen, Trennen. Schlüssel und Beschreibung werden bei operanda gelöscht. Den Schlüssel selbst löschst du beim Anbieter.

Mehr zu Verbindungen