Einführung in die Overcast API-Management

Mit unserer Version vom Sommer 2022 haben wir das Overcast API Management eingeführt, eine einfache Möglichkeit, SAP BAPIs, Tabellen und sogar Backends, die nicht zuSAP gehören, als Webservices zu veröffentlichen. Damit können Unternehmen, die Overcast verwenden, nicht nur jedes Backend in Salesforce integrieren, sondern auch in andere Plattformen. Typische Anwendungsfälle sind die Integration mit Webanwendungen wie Shops oder Portalen, mobilen Anwendungen oder anderen On-Premise Systemen. Mit der Overcast API-Management können Sie auch Partnern und Drittanbietern auf sichere Weise Zugang zur API gewähren. Dieser Blog zeigt, wie das API Management funktioniert und wie einfach es einzurichtet werden kann.

Overcast Integrationsszenarien und Komponenten

Overcast verfügt über das Konzept der Integrationsszenarien und Komponenten. Beide sind wichtig, wenn es um das API-Management geht:

Overcast Integrationsszenario

Das Integrationsszenario beschreibt die Backend-Quelle, die Sie integrieren möchten. Es hat (1) einen Datensatztyp (Echtzeit oder Datensynchronisation), (2) einen Backend-Typ (BAPI, SAP Table, OData, SOAP, etc.), der durch den Verbindungsstring definiert ist und (3) ein bestimmtes Objekt oder eine Tabelle. Darüber hinaus wird beschrieben (4), welche Felder des Objekts Sie integrieren möchten. Ein Beispiel für ein Integrationsszenario ist im folgenden Screenshot zu sehen.

Ein Integrationsszenario zum Lesen der KNA1, der Tabelle SAP für Geschäftspartner-Stammdaten

Overcast Komponenten

Overcast Komponenten sind eine Möglichkeit, Integrationen zu externen oder Backend-Systemen für Benutzer in Salesforce zu erstellen, indem Sie die Konfiguration statt Code verwenden. Sie benötigen ein Echtzeitszenario als Grundlage und stellen die Benutzeroberfläche zur Anzeige der entsprechenden Daten bereit. Overcast Komponenten können ohne Programmierung mit dem Overcast Component Builder erstellt werden.

Ein Integrationsszenario als REST-Web Service bereitstellen

In diesem Beispiel möchten wir die Liste der SAP Kundenaufträge als REST-Webdienst mit Hilfe von BAPI_SALESORDER_GETLIST bereitstellen. Wir werden Postman https://www.postman.com verwenden, um zu zeigen, wie die API genutzt werden kann.

Erstellen des Integrationsszenario

Als Grundlage für unseren RESTful Web Service müssen wir zunächst ein Integrationsszenario erstellen oder ein bestehendes verwenden. Da Overcast mehr als 150 vordefinierte Integrationen für die gängigsten Anwendungsfälle für SAP, Microsoft Business Central/Dynamics und Oracle NetSuite anbietet, steht Ihnen bereits eine große Auswahl zur Verfügung. Eine Schritt-für-Schritt-Anleitung, wie Sie Ihr eigenes Szenario erstellen, finden Sie in der Overcast Hilfe.

Benutzerdefinierte Berechtigung für den API-Zugriff

Aus offensichtlichen Gründen wird nicht jedes Overcast Integrationsszenario automatisch in der API-Management angezeigt. Um dies zu ermöglichen, muss eine benutzerdefinierte Berechtigung erstellt werden. Die Genehmigung muss dieser Namenskonvention entsprechen:

Overcast_Rest_ < integration scenario name >

In unserem Beispiel muss der Name daher Overcast_Rest_sapSalesOrderList lauten. Diese Berechtigung muss jedem Benutzer erteilt werden, der die API aufrufen möchte.

Benutzerdefinierte Berechtigung für den Aufruf des Szenarios sapSalesOrderList

Autorisierung

Für die Autorisierung verwenden wir das Salesforce OAuth 2.0 Protokoll. Einzelheiten finden Sie
hier

Aufrufen des Dienstes

URL: /services/apexrest/overcast/integration/v1/
Die meisten Szenarien erfordern eine Art von Eingabeparametern. Sie können auf verschiedene Weise an die API übergeben werden.

URL Query Parameters

Die Parameter werden der URL als Schlüssel/Wert-Paare hinzugefügt. Wenn wir die Liste der Kundenaufträge nach der Nummer des Geschäftspartners filtern wollen, sieht sie wie folgt aus:

/services/apexrest/overcast/integration/vi/sapSalesOrderList?CUSTOMER_NUMBER=0000001001

Parameter als Teil der URL

Sie können die Parameter auch in die URL einfügen, getrennt durch ein /. Verwenden Sie dazu die Parameter in der gleichen Reihenfolge, wie sie im Szenario vorkommen.

/services/apexrest/overcast/integration/vi/sapSalesOrderList/0000001001

Anfrage mit Body

Der Body der Anfrage kann verwendet werden, um komplexere Strukturen als Input an den Dienst zu übergeben. Es können ein oder mehrere Datensätze oder Strukturen als JSON übergeben werden. Das folgende Beispiel ist die Eingabe für das BAPI zum Abrufen der Kundenauftragsdetails:

{ 
    "SALES_DOCUMENTS": [ 
        { 
            "VBELN": "0000020874" 
        } 
    ], 
    "I_BAPI_VIEW": { 
        "INCOMP_LOG": "", 
        "CREDCARD": "", 
        "CONFIGURE": "", 
        "BILLPLAN": "", 
        "FLOW": "", 
        "TEXT": "", 
        "CONTRACT": "", 
        "SDCOND_ADD": "", 
        "SDCOND": "", 
        "STATUS_I": "", 
        "STATUS_H": "", 
        "ADDRESS": "X", 
        "PARTNER": "X", 
        "BUSINESS": "", 
        "SDSCHEDULE": "", 
        "ITEM": "X", 
        "HEADER": "X" 
    } 
}

Antwort von Overcast

Das Ergebnis wird in JSON-Form zurückgegeben und sieht wie folgt aus:

Das Ergebnis eines API-Aufrufs wird in Postman angezeigt

Das JSON kann von jeder modernen Plattform wie J2EE oder .Net gelesen und umgewandelt werden, die On Premise oder in der Cloud läuft, z. B. auf Amazon AWS, Microsoft Azure, Google Cloud oder Ihrem eigenen Dienst.

Fazit

Der Overcast API-Management ermöglicht es Ihnen, jede beliebige SAP und none-SAP Backend-Datenquelle in einen Webservice zu verwandeln, ohne dass Sie Code schreiben müssen. Wenn Sie mehr darüber erfahren möchten, wie Overcast und unsere REST API Ihrem Unternehmen dabei helfen können, SAP und SAP Daten zu veröffentlichen, nehmen Sie Kontakt mit uns auf.