OBS/Kostenpflichtige Module/RESTServer/Beispiel4

Aus OBS Wiki
Zur Navigation springen Zur Suche springen
Kostenpflichtige Module

Internet-Shop
Der modified ECommerce Shop
Shop-Menü
Automatische Vorgänge
modified eCommerce 2.0
Der Büroring-ShopV4
Einrichtung
Eigene Artikel
brShop24
Einstellungen und Automatiken
Funktionen
Preislisten
Preislistenverwaltung
F10 Weitere Funktionen
Automatiken Kommandos
ZUGFeRD
Factoring
UPS
DHL
IMS Professional
TAPI
SMS
Fleet Management
Mehrlager-Verwaltung
Mehrsprachen Modul
Multilanguage Modul
Einfache Produktionsnachverfolgung
DMS - Dokumenten Management System
DMS Dokumente
Tasten und Schaltflächen
F10 Weit.
E DMS Definitionen
QR Zeiterfassung
EVA Marketing Tool
Technikersteuerung
Termin-Projekte
Edifact-Schnittstelle
Backup Überwachung Email
Anlagenbuchhaltung
OBS Geo Daten
DeliSprint / DPD
Filialen
Auto-Waagen
Cashback
Moebelschnittstelle
Tourenplanung
Tourenplanung
Dokumenten Manager
DocuWare-Schnittstelle
OFML-Kalkulation
Pascom
Versicherungsschaden
Gutschriftsanzeigen
OCPP Ladestationen
Kameraverwaltung
DataInOut
REST-Schnittstelle
Beispiele
Sammelverträge
Craftboxx
OpenMasterData / IDS
Sammelpositionen


Beispiel 4 – Pfad-Parameter (REST-Routing über Templates)

Dieses Beispiel zeigt das Pfad-Template-Routing mit Platzhaltern. Eine Auftrags-Ressource wird über drei Endpunkte abgebildet:

Methode + Pfad Zweck
GET /orders Liste aller offenen Aufträge
GET /orders/{uid} Einzelner Auftrag per UID
PUT /orders/{uid}/modules/{code} Status eines Auftrags-Moduls ändern

Die Platzhalter {uid} und {code} stehen im Skript als oParams.Values['_OBS_PATH_uid'] bzw. oParams.Values['_OBS_PATH_code'] zur Verfügung.

Einrichtung in OBS

  • Server-Profil: Standard-TLS-Profil Public-API auf 0.0.0.0:443.
  • Zugang: Orders-Client mit API-Key, Zugriff auf die drei Endpunkte.
  • Endpunkte (je ein Eintrag in RESTSRV_ENDPOINTS, alle Profil Public-API):
Endpunkt Pfad-Template Skript-Methode
orders /orders Get (Liste)
orders /orders/{uid} Get (Einzel)
orders /orders/{uid}/modules/{code} Put

Endpunkt-Skript 1: GET /orders (Liste)

// Hilfsfunktion: ein Auftrag als JSON-Objekt
function _OrderAsJSON(qOrder: TqSQL): TJSONObject;
begin
    result := TJSONObject.Create();
    result.AddPair('uid'      , qOrder.A2UID());
    result.AddPair('nr'       , qOrder.A2C('au_nr'));
    result.AddPair('kunde'    , qOrder.A2C('au_kunde'));
    result.AddPair('status'   , qOrder.A2C('au_status'));
    result.AddPair('aenderung', DTToSQL(qOrder.A2D('au_aend_dat')));
end;

function Get(oParams: TStrings; oBody: TJSONObject): string;
var cSql : string;
    qData: TqSQL;
    oArr : TJSONArray;
begin
    oArr := TJSONArray.Create();

    cSql := 'SELECT * FROM auftraege' +
            ' WHERE au_status <> ' + DB_SQLVal('9') +
            ' ORDER BY au_nr';
    if (DB_SOpen('Y00ORDLST1', oDB, cSql, qData)) then begin
        while (not qData.EoF) do begin
            oArr.Add(_OrderAsJSON(qData));
            qData.Next();
        end;
    end;

    result := oArr.ToJSON();
end;

Endpunkt-Skript 2: GET /orders/{uid} (Einzel)

function _OrderAsJSON(qOrder: TqSQL): TJSONObject;
begin
    result := TJSONObject.Create();
    result.AddPair('uid'      , qOrder.A2UID());
    result.AddPair('nr'       , qOrder.A2C('au_nr'));
    result.AddPair('kunde'    , qOrder.A2C('au_kunde'));
    result.AddPair('status'   , qOrder.A2C('au_status'));
    result.AddPair('aenderung', DTToSQL(qOrder.A2D('au_aend_dat')));
end;

function Get(oParams: TStrings; oBody: TJSONObject): string;
var cUid : string;
    cSql : string;
    qData: TqSQL;
begin
    // Pfad-Parameter aus /orders/{uid}
    cUid := oParams.Values['_OBS_PATH_uid'];
    if (cUid = '') then begin
        result := '{"error":"uid fehlt"}';
        exit;
    end;

    cSql := 'SELECT * FROM auftraege WHERE sys_uid = ' + DB_SQLVal(cUid);
    if (DB_SOpen('Y00ORDGET1', oDB, cSql, qData)) and (not qData.EoF) then begin
        result := _OrderAsJSON(qData).ToJSON();
    end else begin
        result := '{"error":"Auftrag nicht gefunden"}';
    end;
end;

Endpunkt-Skript 3: PUT /orders/{uid}/modules/{code}

function Put(oParams: TStrings; oBody: TJSONObject): string;
var cUid   : string;
    cCode  : string;
    cStatus: string;
    cSql   : string;
    qChk   : TqSQL;
    xMod   : TqSQL;
begin
    // Beide Pfad-Parameter
    cUid  := oParams.Values['_OBS_PATH_uid'];
    cCode := oParams.Values['_OBS_PATH_code'];
    if (cUid = '') or (cCode = '') then begin
        result := '{"error":"uid oder code fehlt"}';
        exit;
    end;

    // Nutzdaten kommen aus dem JSON-Body
    cStatus := '';
    if (Assigned(oBody)) then begin
        oBody.TryGetValue<string>('status', cStatus);
    end;
    if (cStatus = '') then begin
        result := '{"error":"status fehlt"}';
        exit;
    end;

    // Existenzpruefung
    cSql := 'SELECT * FROM auftrag_module' +
            ' WHERE am_auftrag = ' + DB_SQLVal(cUid) +
            ' AND am_code = ' + DB_SQLVal(cCode);
    if (not DB_SOpen('Y00ORDMOD1', oDB, cSql, qChk)) or (qChk.EoF) then begin
        result := '{"error":"Modul nicht gefunden"}';
        exit;
    end;

    // Update
    xMod := qSqlRead('Y00ORDMOD2', oDB, 'auftrag_module',
                     'am_auftrag = ' + DB_SQLVal(cUid) +
                     ' AND am_code = ' + DB_SQLVal(cCode));
    xMod.qSet('am_status', cStatus);
    xMod.SaveData(UPDATE_RECORD);
    qSqlFree(xMod);

    result := '{"status":"ok"}';
end;

Test mit curl

# Liste
curl -H "apikey: GEHEIM123" https://api.meinserver.de/orders

# Einzelner Auftrag (uid als Pfad-Parameter)
curl -H "apikey: GEHEIM123" https://api.meinserver.de/orders/4711

# Modul-Status aendern (uid + code als Pfad-Parameter, status im Body)
curl -X PUT \
     -H "apikey: GEHEIM123" \
     -H "Content-Type: application/json" \
     -d '{"status":"21"}' \
     https://api.meinserver.de/orders/4711/modules/A1

Was dieses Beispiel zeigt

  • Eine Ressource, mehrere Pfad-Formen über getrennte Endpunkt-Einträge mit eigenem Skript und eigener Berechtigung.
  • Pfad-Parameter werden über {name} im Template erfasst und im Skript als oParams.Values['_OBS_PATH_name'] gelesen.
  • Reihenfolge der Skript-Parameter: oParams zuerst, oBody danach (umgekehrt zur internen Dispatch-Reihenfolge).
  • Präzedenz: ein statisches Segment (z. B. /orders/summary) hätte Vorrang vor /orders/{uid}.

Siehe auch

Abgerufen von „http:///index.php?title=OBS/Kostenpflichtige_Module/RESTServer/Beispiel4&oldid=64517“