Webplattform API

Owned by a.kneer
Last updated: Jul 22, 2022
1 min read

Die Webplattform-API bietet REST-Funktionen zur Entwicklung individueller Erweiterungen für die
Ratio-Produktpalette. Die Kommunikation erfolgt per HTTP. Nachrichten werden im JSON-Format
übertragen. Voraussetzung zur Verwendung der API ist die Einrichtung eines Mandanten für das
Unternehmen in der Webplattform von RATIOsoftware.
Die Webplattform ist eine Hybrid Cloud. Auf einem zentralen Webserver, der von RATIOsoftware
verwaltet wird, sind alle Webanwendungen installiert und von überall auf der Welt aufrufbar. Die
unternehmensspezifischen Daten verbleiben in der lokalen Datenbank des Unternehmens.
Der Datenaustausch zwischen zentralem Webserver und Unternehmensdatenbank erfolgt über ein
Schnittstellenmodul, das einmalig im Unternehmen installiert wird, die sogenannte Bridge.

Sobald die Bridge eingerichtet ist, können die verfügbaren Funktionen mit Mandantenkennung und APISchlüssel aufgerufen werden.

Beim Aufruf einer API-Funktion können Mandantenkennung [MANDANT] und API-Schlüssel [KEY] auf
eine der folgenden Arten übergeben werden:

  • HTTP-Header: x-rs-api-key=[MANDANT]$[KEY]

  • URL-Parameter: x-rs-api-key=[MANDANT]$[KEY]

  • POST-Request-Body:

{ "data": {...}, "meta": { "credentials_api": { "mandant": "[MANDANT]", "token": "[KEY]" } } }

Sollten API’s verwendet werden, müssen diese von einem Ratio Mitarbeiter freigeschalten werden. Sobald diese in Verwendung sind, werden wir die API Nutzung in Rechnung stellen.
Bitte schreiben Sie uns hierfür ein Ticket: Neues Ticket

Sollte eine individuelle SQL Anweisung ausgeführt werden, muss diese von RATIOsoftware geprüft und freigegeben werden.

Bitte schreiben Sie uns hierfür ein Ticket: Neues Ticket

Folgende Anleitungen gibt es für die API Schnittstelle: