Zum Hauptinhalt springen

SAP-Verbindung

Verbindungsdetails für das SAP-System.

info

Wenn SAP die OData‑Schnittstelle (V2 oder V4) verwendet und die Daten paginiert zurückgibt, folgt der SAP REST Connector automatisch dem in der Antwort bereitgestellten „next“-Link, bis alle Datensätze abgerufen sind.

Das sapConnection Request Schema ist hier unter sapConnection zu finden.

Beispiel​

"sapConnection": {
    "baseUrl": "https://sap-api.example.com",
    "authentication": {
        "username": "sap_user",
        "password": "sap_password"
    },
    "endpoint": "/odata4/sap/api_cost_center/srvd_a2x/sap/costcenter/0001/A_CostCenterText_2",
    "queryParams": {
        "$select": "Language,ControllingArea,CostCenter,ValidityEndDate,CostCenterName,CostCenterDescription",
        "$expand": "*"
    }
}
"sapConnection": {
    "baseUrl": "https://sap-api.example.com",
    "authentication": {
        "clientCrtPath": "./path/to/client-cert.pem",
        "clientKeyPath": "./path/to/client-key.pem",
        "caCrtPath": "./path/to/ca-cert.pem"
    },
    "endpoint": "/odata4/sap/api_cost_center/srvd_a2x/sap/costcenter/0001/A_CostCenterText_2",
    "queryParams": {
        "$select": "Language,ControllingArea,CostCenter,ValidityEndDate,CostCenterName,CostCenterDescription",
        "$expand": "*"
    }
}

Beschreibung​

baseUrl string​

  • Enthält die Basis-URL der SAP-API. Sie dient als Grundlage, an die weitere Pfadangaben (z. B. der Endpoint und die Query Parameter) angehängt werden.

authentication object, optional, default: undefined​

  • Gibt die Authentifizierungsmethode an, die für den Zugriff auf die SAP-Cloud-API verwendet wird. Es gibt zwei mögliche Optionen:
    • Benutzername und Passwort: Ein Objekt mit den Feldern username und password, die für die Basic-Authentifizierung verwendet werden.
    • Zertifikatsbasierte Authentifizierung: Ein Objekt mit den Feldern clientCrtPath, clientKeyPath und caCrtPath, die auf die entsprechenden Zertifikatsdateien verweisen.
  • Hinweis: Die in der .env-Datei hinterlegte Authentifizierung wird durch diese Werte überschrieben, falls diese angegeben sind.

endpoint string​

  • Gibt den spezifischen Pfad innerhalb der API an, über den auf die gewünschten Ressourcen zugegriffen wird. Dieser Pfad wird an die Base-URL angehängt.

queryParams object, optional, default: undefined​

  • Ein Objekt, das zusätzliche Abfrageparameter enthält, um die API-Anfrage weiter zu spezifizieren. Für eine vollständige Dokumentation siehe hier. Ein kleiner Auszug sind folgende:

    $select string​

    • Definiert eine kommagetrennte Liste von Feldern, die in der Antwort enthalten sein sollen. Hier werden beispielsweise "Language", "ControllingArea", "CostCenter" und weitere Felder ausgewählt.

    $expand string​

    • Mit diesem Parameter wird angegeben, ob und welche verwandten Datensätze (Relationen) ebenfalls abgerufen werden sollen. Das Sternchen "*" signalisiert in der Regel, dass alle verfügbaren Erweiterungen geladen werden sollen.

    $top string​

    • Gibt die ersten n Elemente einer Ergebnismenge zurück und begrenzt so die Anzahl der zurückgegebenen Datensätze.