Skip to Content

Discover Sales Order API from S/4HANA Cloud System

Discover the Sales Order API from S/4HANA Cloud system.
You will learn
  • How to discover APIs from SAP API Business Hub
  • How to create API proxy
  • How to tryout APIs in API Management
  • How to get the API key
shilpavijShilpa VijApril 11, 2021
Created by
March 18, 2019
  • Step 1
    1. From trial cockpit, click Access API Portal link to launch API portal.

      Access API Portal
    2. From API Portal expand menu, click Discover to connect to API catalog of SAP API Business Hub.

      Navigate Discover

      The API Discovery menu will open with many API packages available for consumption.

    3. Click the SAP S/4HANA Cloud package to discover available APIs.

      Open Package
    4. Click the Artifacts tab to view the available APIs.

      Navigate Artifacts
  • Step 2
    1. Click the Search Bar and type sales order to search for sales order API.

    2. Find the Sales Order – Create, Read, Update, Delete (A2X) API and under Actions select Copy.

      Search Sales Order
    3. From the copy wizard, select sandbox URL and click OK.

      Copy API

      You will be returned to the API Develop area.

    4. For API_SALES_ORDER_SRV click Deploy.

      Deploy API
    5. Open the created API proxy for example API_SALES_ORDER_SRV

      API Proxy has all the documentation imported automatically.

      Open API
    6. Click Resources tab to see the Open API spec (Swagger) documentation that will be published to developers.

      Resources Tab
  • Step 3
    1. Expand the open API specification definition to see additional documentation and Try out feature which can help developers get started on the API more quickly.

      Click Try out

      Try out
    2. Give $top as 3.

      Top Records
    3. Click Execute.

      Execute API

      The call will fail as it requires Verify API Key policy.

      The Verify API Key policy lets you enforce verification of API keys at runtime, letting only apps with approved API keys access your APIs. This policy ensures that API keys are valid, have not been revoked, and are approved to consume the specific resources associated with your API products.

  • Step 4
    1. Go to SAP API Business Hub, to get your API Key.

      Click Log On button.

      API Hub
    2. Click API package for example SAP S/4HANA Cloud.

      API Package
    3. Click Sales Order API to open the API details.

      API Details
    4. Click Show API Key button.

      API Key
    5. Click Copy Key and Close button.

      Save API Key value somewhere for later, e.g. Notepad or Notes, etc.

      Copy API Key

    Where can you get the API key ?

Back to top