Zusammenfassung
Die MindBridge Application Programming Interface („API“) ermöglicht es Ihnen, Berechtigungen und den Zugriff auf verschiedene Aspekte Ihres MindBridge-Mieters zu steuern, einschließlich Bibliotheken, Organisationen, Aufträge und Analysen.
Mit der API können Sie Dateien sicher von Ihrem ERP direkt in den Dateimanager übertragen, die Daten in eine Analyse importieren und die Analyse ausführen – alles von außerhalb der MindBridge-App. Anschließend können Sie einfach in MindBridge einsteigen, um die Analyseergebnisse anzusehen.
Erfahren Sie mehr über die allgemeine Nutzung der MindBridge-API.
Konfigurationsdetails
Sie müssen ein App-Admin sein, um auf die API-Seite zuzugreifen.
Wie erhalte ich Zugang zur API?
Kontaktieren Sie Ihren App-Admin, um Zugang zur MindBridge-API zu beantragen.
Wie funktioniert eine API?
Eine API ermöglicht es einer Anwendung, über eine Reihe klar definierter Befehle mit der MindBridge-App zu kommunizieren, wodurch ein sicherer Zugriff auf Unternehmensvermögenswerte und -prozesse über eine REST-Schnittstelle ermöglicht wird.
Wie im untenstehenden Bild dargestellt, ist die Nutzung einer API vergleichbar mit der Bestellung in einem Restaurant. Denken Sie an API-Befehle wie an eine Bestellung von der Speisekarte eines Restaurants – die Speisekarte definiert eine Liste verfügbarer „Gerichte“ (d. h. Programme oder Funktionen), und wenn Sie eine Bestellung aufgeben, bereitet die Küche (d. h. der Server oder die Datenbank) das Essen (d. h. die Anfrage) im Hintergrund zu und sendet es Ihnen, wenn es fertig ist.
Kurz gesagt, APIs definieren eine Liste von Befehlen. Wenn ein ERP einen dieser Befehle verwendet, sendet MindBridge das Angeforderte zurück.
Was ist eine REST-Architektur?
MindBridge verwendet eine RESTful-API-Architektur, die es Computersystemen ermöglicht, Informationen sicher über das Internet unter Verwendung des HTTPS-Protokolls auszutauschen. Anfragen, die über eine RESTful-API gestellt werden, sind zustandslos, und jede Anfrage enthält alle notwendigen Daten, um die Anfrage erfolgreich abzuschließen.
Was sind die Vorteile der Nutzung einer API?
APIs ermöglichen:
- Skalierbare Datenaufnahme und Exportieren von Ergebnissen unter Verwendung von Automatisierung
- Eine einheitliche Datenanalyseplattform, unabhängig von den Anforderungen der Branche oder Organisation
- Sicheren und kontrollierten Zugriff auf MindBridge-Daten, was neue Möglichkeiten für Analysen und Erkenntnisse im großen Maßstab schafft
- Die Automatisierung komplexer, wiederholbarer Aufgaben
Was ist ein MindBridge-API-Token?
Ein MindBridge-API-Token (ein „API-Token“) ist eine Zeichenfolge, die als Schlüssel zur API fungiert und als Authentifizierungs-Token implementiert wird. Es wird verwendet, indem das Token dem Header jeder HTTPS-Anfrage hinzugefügt wird.
Dieser Token-Typ ist ein kryptografisch sicheres Authentifizierungs-Token, das die konfigurierten Berechtigungen enthält und es API-Clients ermöglicht, auf MindBridge-API-Ressourcen oder „Endpunkte“ zuzugreifen.
Wie verwende ich das API-Token?
Um ein innerhalb der MindBridge-Plattform generiertes Token zu verwenden, müssen Sie Folgendes zum Header jeder HTTPS-Anfrage hinzufügen:
Authorization: Bearer {token} Accept: application/json
Wie lange halten API-Tokens?
Der Token-Lebenszyklus ist vom App-Admin für einen beliebigen Zeitraum konfigurierbar, bis zu einem Maximum von 2 Jahren.
Was passiert, wenn mein API-Token kompromittiert wird?
Tokens müssen an einem sicheren Ort aufbewahrt werden und sollten niemals geteilt werden. Die Sicherheit Ihres Tokens ist von größter Bedeutung.
Wenn ein Token kompromittiert wird, sollte der App-Admin das Token sofort deaktivieren und neu ausstellen.
Was ist ein Endpunkt?
Endpunkte sind exponierte Funktionen einer Anwendungs-API mit Funktionalität, die durch HTTPS-Methoden bereitgestellt wird.
Was ist eine HTTPS-Methode?
Eine HTTPS-Methode repräsentiert Funktionalität, die vom HTTPS-Protokoll unterstützt wird, wie GET, POST, PUT, PATCH und DELETE.
Diese Methoden ermöglichen es Ihnen im Wesentlichen, Bibliotheken, Organisationen, Aufträge, Analysen, Benutzer und vieles mehr zu lesen, zu schreiben oder zu löschen.
Wie werden API-Tokens generiert?
Ein App-Admin erstellt API-Tokens im Admin-Bereich der App, wo sie den Lebenszyklus und die Berechtigungen für jedes Token festlegen können.
Erfahren Sie, wie Sie ein MindBridge-API-Token erstellen.
Wer kann auf die API zugreifen und sie nutzen?
Jeder, der ein gültiges Token hat, kann die API nutzen.
App-Admins sind verantwortlich für die Verwaltung von API-Tokens und können API-Zugriff auf alle Benutzer innerhalb des Auftrags gewähren.
Wie verwende ich die API?
Um die API zu verwenden:
- Ein API-Token muss von einem App-Admin innerhalb von MindBridge generiert werden.
- Sobald Sie Zugriff auf das API-Token haben, verwenden Sie das HTTPS-Protokoll, um eine Anfrage an einen dokumentierten Endpunkt in der MindBridge-API zu stellen.
Anfragen können von verschiedenen Quellen gestellt werden, einschließlich der meisten Programmiersprachen oder Postman.
Welches Format wird für die Kommunikation mit der API verwendet?
Die API verwendet JSON für alle Anfragen und Antworten, mit Ausnahme von Datendateien, die in jedem innerhalb der Anwendung unterstützten Format importiert werden können.
Welche Dateiformate werden über die API akzeptiert?
Eingehend
Alle Dateiformate, die derzeit vom Dateimanager unterstützt werden, werden akzeptiert, wie .xlsx, .csv, .xlsb und mehr.
Ausgehend
Nur JSON-Ergebnisse.
Welche Dateien kann ich über die API übertragen oder abrufen?
Eingehend
Alle Dateien, die derzeit von der MindBridge-Plattform unterstützt werden, können über die API übertragen werden.
Dateien können jeder Quelle innerhalb einer Analyse zugewiesen werden, wie dem Slot „Hauptbuchdetails“.
Ausgehend
Die API unterstützt paginierte, abfragbare Analyseergebnisse, die entweder nach Transaktionen oder Buchungen indiziert sind. Die verfügbaren Daten entsprechen der Datentabelle in der MindBridge-Plattform.
Wo finde ich detailliertere Dokumentationen?
Die folgenden Artikel bieten zusätzliche Details und Anleitungen zur MindBridge-API.
Für technische Dokumentationen öffnen Sie das Aktionen-Menü auf der rechten Seite der API-Registerkarte und wählen Sie API-Referenz anzeigen. Sie werden zum API-Referenzdokument weitergeleitet.
Um eine laufende Liste der Änderungen an der API zu sehen, öffnen Sie das Aktionen-Menü auf der rechten Seite der API-Registerkarte und wählen Sie API-Änderungsprotokoll anzeigen. Sie werden zum API-Änderungsprotokoll weitergeleitet.
Für weitere Informationen oder kontaktieren Sie uns unter info@mindbridge.ai.
Wo kann ich als Benutzer der API anfangen?
- Lesen Sie die MindBridge-API-Dokumentation
- Generieren oder erhalten Sie Zugriff auf ein API-Token
- Probieren Sie die gewünschten API-Endpunkte und Aktionen aus
Sonst noch etwas auf dem Herzen? Chatten Sie mit uns oder senden Sie eine Anfrage für weitere Unterstützung.