Eine Anfrage hat eine Adresse und einen Zweck
Bei einer HTTP-API sendet dein Code eine Anfrage an eine bestimmte Adresse, den sogenannten Endpunkt. Die Methode gibt die Art der Aktion an. GET ruft Informationen ab. POST erstellt häufig etwas oder startet einen Vorgang. Die Dokumentation des jeweiligen Endpunkts beschreibt das genaue Verhalten.
Die Antwort enthält einen Statuscode und kann strukturierte Daten wie JSON enthalten. Dein Code verarbeitet die Antwort und arbeitet weiter. Eine gute Integration hat auch einen Plan für den Fall, dass eine Anfrage wiederholt werden muss oder Aufmerksamkeit erfordert.
Ein konkretes Beispiel
Kunden von Alunta abrufen
Eine dokumentierte Leseanfrage, hier ohne Zugriffstoken zur Erklärung.
GET https://app.alunta.com/api/v1/customers
- Methode
- GET – Informationen abrufen
- Ressource
- /customers – Kunden
- Authentifizierung
- Bearer-Token
- Bei erfolgreicher Anfrage
- Kundendaten als JSON
Diese Anfrage ändert keine Daten. Lies vor der Implementierung die Referenz zu Antwortstruktur, Seitennavigation und Zugriffsanforderungen.
Dokumentation und Zugriff gehören zusammen
Die API-Referenz von Alunta beschreibt Ressourcen wie Kunden, Abonnements und Rechnungen. Die OpenAPI-Datei beschreibt die Schnittstelle in einem Format, das auch Entwicklerwerkzeuge lesen können: Adressen, Felder, Antworten und Authentifizierungsanforderungen.
Das Beispiel benötigt ein gültiges Bearer-Token mit den erforderlichen Zugriffsrechten für dein Alunta-Konto. Bewahre das Token sicher auf deinem Server auf, außerhalb öffentlich zugänglichen Browsercodes. Dokumentation und Token-Berechtigungen legen fest, auf welche Informationen und Aktionen eine Integration zugreifen darf. Beginne mit einer lesenden Anfrage, bevor du Änderungen in deinen Ablauf einbaust.
APIs, Webhooks und MCP erfüllen unterschiedliche Aufgaben
Bei einer API stößt dein Code eine Anfrage an: „Rufe meine Kunden ab“. Bei einem Webhook sendet das System deiner Integration eine Nachricht, wenn ein Ereignis eintritt, zum Beispiel eine Zahlung. So muss deine Integration Änderungen nicht ständig durch wiederholte Anfragen prüfen.
MCP ist ein Standard, um KI-Anwendungen mit externen Daten und Werkzeugen zu verbinden. Damit lassen sich ausgewählte Funktionen einem KI-Assistenten auf andere Weise bereitstellen. MCP legt nicht automatisch jede API-Funktion offen. Sieh dir die API- und KI-Zugangsseiten von Alunta an und wähle die Verbindung passend zu deiner Aufgabe.
Fragen und Antworten
Ist eine API dasselbe wie eine fertige Integration?
Nein. Eine API ist eine Schnittstelle, mit der du selbst etwas entwickeln kannst. Eine fertige Integration verbindet Systeme und hat bereits Entscheidungen zu Daten, Synchronisierung und Fehlerbehandlung getroffen.
Muss ich Entwickler sein, um Alunta zu nutzen?
Nein. Du kannst die Alunta-Oberfläche und passende fertige Integrationen verwenden. Die API ist für Abläufe gedacht, bei denen eigener Code Alunta mit einem anderen Produkt oder Prozess verbindet.
