• Schedule a demo
  • Contact
  • English
    • 日本語 (Japanese)
    • Deutsch (German)
Vigience
  • VIGIENCE OVERCAST
  • Platform
    • VIGIENCE OVERCAST PLATFORM
      • Overcast Solution Architecture
        • New to Overcast? Learn how Overcast connects on-premise and the cloud.
      • Overcast Integration App
        • Build data sync and realtime integrations within minutes and turn Salesforce into a portal for all your backend systems.
      • Overcast Applications
        • Designing business process integrations with complex systems such as SAP is very hard so we prebuilt them and provide them as a product.
      • Overcast Component Builder
        • Build-your-own Lightning Components for SAP and non-SAP systems
      • The Overcast Difference
        • Overcast is not a traditional iPaaS or ETL tool. Learn more here.
      • Overcast + Mulesoft / SAP CPI
        • Overcast enhances and connects to your existing Mulesoft or SAP CPI.
      • Pricing
        • Learn about the Overcast pricing model.
    • Vigience Overcast Video
  • Applications
    • Vigience Overcast SAP Salesforce Applications
    • SALESFORCE ADD-ONS – SAP
      • SAP-integrated Customer 360
      • SAP-integrated Order Management
      • SAP-integrated Quote Management
      • SAP-integrated Asset Mgmt & Field Service
      • SAP-integrated Self-Service Portals
      • SAP-integrated Commerce Cloud
      • SAP-integrated Manufacturing Cloud
      • SAP-integrated Consumer Goods Cloud
    • SALESFORCE ADD-ONS – OTHER
      • Microsoft Dynamics 365 Integration
        • Leverage our prebuilt Microsoft Dynamics 365 integrations or point & click build your own.
      • Oracle Netsuite Integration
        • Learn more about using our prebuilt NetSuite integrations and how to build your own.
      • Other Integrations
        • Point & click build your own Overcast Components and Data Synchronizations against any backend in days.
    • FEATURE HIGHLIGHTS
      • SAP Attachments and ArchiveLink in Salesforce – new Overcast feature
      • Salesforce as a Call Center Portal for multiple Systems
      • Introducing the Overcast API Management
      • The new Enhanced SAP Sales Order Management
  • Resources
    • Vigience Overcast Case Studies
      • Case Studies
        • Explore best practices by digital thought leaders
    • Vigience Overcast Blog
      • Blog
        • Stay up-to-date on Overcast and all things Vigience
    • Vigience Overcast Video
      • Videos
        • Our directory for all Vigience videos and webinars
    • Vigience Overcast Whitepaper
      • Whitepaper
        • Reports, ebooks, guides, and more to help you grow
    • Vigience Overcast Knowledgebase
      • Knowledge Base
        • Link to our knowledge base at help.vigience.com
    • Vigience Overcast Community
      • Community
        • Share and acquire knowledge in the Overcast community
  • Company
    • The Salesforce-Overcast-SAP Solution Architecture

      • "Today, most modern enterprises rely on a de-facto enterprise software solution architecture, built on SAP and Salesforce. However, to allow end users to truly benefit from the Salesforce and SAP implementation, the two systems need to be deeply connected and synced in real-time, as enabled by Overcast."
        Markus Stierli, Vigience CEO Salesforce SAP Integration

    • company
      • What we do
        • Vigience is a fast-growing independent software vendor that provides SaaS services to Salesforce and/or SAP customers.
      • Who we are
        • The Vigience team started as a spin-off from the former SAP Technology R&D team.
      • Partner
        • Learn more about how we work with our implementation, referrer and solution partners.
      • Career
        • Join us to work on the world's most advanced enterprise IT projects together with thought-leading customers and partners.
  • Search
  • Menu Menu

Product Updates, Technical Articles

Introducing the Overcast API Management

With our Summer 2022 release, we introduced the Overcast API Management, an easy way to expose SAP BAPIs, tables and even non-SAP backends as web services. This allows organizations that use Overcast not only to integrate any backend into Salesforce, but also into other platforms. Typical use cases are the integration with web apps like shops or portals, mobile applications or other on premise systems. The Overcast API Management also allows you to give access to the API to partners and 3rd parties in a secure way. This blog shows how the API Management works and how easy it is to set it up.

Overcast Integration Scenarios and Components

Overcast has the concept of Integration Scenarios and Components. Both are important when it comes to the API Management:

Overcast Integration Scenario

The Integration Scenario describes which backend source you want to integrate. It has (1) a record type (Real-time or Data Synchronization), (2) a backend type (BAPI, SAP table, OData, SOAP, etc.) that is defined by the connection string and (3) a specific object or table. On top of that it describes (4) which fields of the object you want to integrate. An example for an Integration scenario can be seen in the following screenshot.

Integration scenario for reading the KNA1
An integration scenario for reading the KNA1, the SAP table for business partner master data

Overcast Components

Overcast Components are a way to build integrations to external or backend systems for users in Salesforce using configuration rather than code. They require a real-time scenario as their basis and provide the user interface to display the corresponding data. Overcast Components can be built without coding by using the Overcast Component Builder.

Exposing an Integration Scenario as REST Web Service

In this example we want to expose the list of SAP Sales Orders as a REST web service by using BAPI_SALESORDER_GETLIST. We will use Postman https://www.postman.com to show how the API can be consumed.

Create the Integration Scenario

As a bases for our RESTful web service, we first need to create an integration scenario or use an existing one. As Overcast offers more than 150 predefined integrations for the most common use cases for SAP, Microsoft Business Central/Dynamics and Oracle NetSuite, there is already plenty to choose from. A step-by-step guide about how to create your own scenario can be found in the Overcast help. 

Custom Permission for allowing API access

For obvious reasons, not every Overcast integration scenario is automatically exposed in the API Management. To allow this, a custom permission must be created. The permission must follow this naming convention:

Overcast_Rest_ < integration scenario name >

Therefore, in our example, the name must be Overcast_Rest_sapSalesOrderList. This permission must be added to any user, that wants to call the API.


Custom permission for calling the sapSalesOrderList scenario

Authorization

For the authorization we are using the Salesforce OAuth 2.0 protocol. Details can be found here

Calling the service

URL: /services/apexrest/overcast/integration/v1/
Most scenarios require some type of input parameters. They can be passed to the API in multiple ways.

URL Query Parameters

Parameters are added to the URL as key/value pairs. If we want to filter the list of Sales Orders by business partner number, it will look like this:

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

Parameters as part of the URL

You can also add the parameters to the URL, separated by a /. For this, use the parameters in the same order, as they are in the scenario.

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

Request with body

The body of the request can be used to transfer more complex structures as input to the service. With one or multiple records or structures can be passed in as JSON. The following for example is the input for the BAPI to fetch the sales order details:

{ 
    "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" 
    } 
}

Response from Overcast

The result is returned in JSON form and looks like this:

The result of an API call displayed in Postman
The result of an API call displayed in Postman

The JSON can be read and transformed by any modern platform like J2EE or .Net running on premise or in the cloud on for example Amazon AWS, Microsoft Azure, Google Cloud or your own service.

Conclusion

The Overcast API Management allows you to turn any SAP and none-SAP backend data source into a web service without the need to write any code. If you want to learn more about how Overcast and how our REST API can help your organization to expose SAP and none-SAP data, get in touch with us.

AUTHOR

Alexander Ilg

Alexander Ilg

VICE PRESIDENT
PRODUCT MANAGEMENT OVERCAST

Categories

  • Business Process Insights (2)
  • Product Updates (3)
  • Release Notes (2)
  • Technical Articles (2)

Tags

API (3) API Management (3) Attachments (3) Call Center (3) Customer 360 (3) Documents (3) Low-Code (3) No-Code (3) OAuth (3) Portal (3) REST (3) Salesforce (15) Sales Orders (3) SAP (18) Utility (3) VA01 (3)
Related Entries
REST API
December 5, 2022

Introducing the Overcast API Management

November 18, 2022

No code/low code at SAP and Salesforce: one works, one doesn’t

November 17, 2022

Salesforce as a Call Center Portal for multiple Systems

SHARE THIS ENTRY
  • Share on Facebook
  • Share on Twitter
  • Share on LinkedIn
  • Share by Mail

Schedule a demo

The #1 Salesforce-Native Integration App

  •  Overcast is a Salesforce-native cloud integration service that lets you quickly and easily  connect Salesforce to your SAP, Oracle, Microsoft and other on-premise applications.
  •  No on-premise software or middleware installations.
  •  Thousands of SAP business objects can be integrated in a point-and-click fashion.

Direct Contact

+1 (415) 226-9867
Vigience, Inc.

Vigience Overcast
Overcast is a Vigience product

Salesforce Appexchange

Overcast Teaser Video
WATCH THE OVERCAST TEASER VIDEO

Appexchange Reviews

Awesome solution – 10 years ahead of everything

We are Europe’s leader in manufacturing of memory products and are running this solution since 3 years for sales order, forecasting and account data integration. Sychronization is done in time without any delay. Every account manager has immediate access to order and shipment information and he can update his forecast immediately to drive the supply chain.
Thanks to overcast we can use far more order information by using Salesforce. We immediately can generate a sales order based on opportunity information which saves time and avoids mistakes.
more

Social Media Channels

Vigience Overcast Linkedin

Vigience Overcast Facebook

Vigience Overcast Youtube

Vigience Overcast Twitter

Compliance Certifications

Security Certifications

Vigience Overcast is SAP certifiedVigience Overcast is SAP certified

NEWSLETTER

Loading
© Copyright - Vigience, Inc.
  • Privacy Policy
Release Notes Vigience Overcast Spring 2023
Scroll to top
Cleantalk Pixel

This site uses cookies. By continuing to browse the site, you are agreeing to our use of cookies.

Accept settingsHide notification onlySettings

Cookie and Privacy Settings



How we use cookies

We may request cookies to be set on your device. We use cookies to let us know when you visit our websites, how you interact with us, to enrich your user experience, and to customize your relationship with our website.

Click on the different category headings to find out more. You can also change some of your preferences. Note that blocking some types of cookies may impact your experience on our websites and the services we are able to offer.

Essential Website Cookies

These cookies are strictly necessary to provide you with services available through our website and to use some of its features.

Because these cookies are strictly necessary to deliver the website, refusing them will have impact how our site functions. You always can block or delete cookies by changing your browser settings and force blocking all cookies on this website. But this will always prompt you to accept/refuse cookies when revisiting our site.

We fully respect if you want to refuse cookies but to avoid asking you again and again kindly allow us to store a cookie for that. You are free to opt out any time or opt in for other cookies to get a better experience. If you refuse cookies we will remove all set cookies in our domain.

We provide you with a list of stored cookies on your computer in our domain so you can check what we stored. Due to security reasons we are not able to show or modify cookies from other domains. You can check these in your browser security settings.

Google Analytics Cookies

These cookies collect information that is used either in aggregate form to help us understand how our website is being used or how effective our marketing campaigns are, or to help us customize our website and application for you in order to enhance your experience.

If you do not want that we track your visit to our site you can disable tracking in your browser here:

Other external services

We also use different external services like Google Webfonts, Google Maps, and external Video providers. Since these providers may collect personal data like your IP address we allow you to block them here. Please be aware that this might heavily reduce the functionality and appearance of our site. Changes will take effect once you reload the page.

Google Webfont Settings:

Google Map Settings:

Google reCaptcha Settings:

Vimeo and Youtube video embeds:

Privacy Policy

You can read about our cookies and privacy settings in detail on our Privacy Policy Page.

Accept settingsHide notification only