Create Your First Application with SAP Cloud SDK for JavaScript

Initially, the app only contains the index and hello-world routes. We will add another route for business-parters that will simply list all available business partners.

First, create a new file business-partner-route.ts in the src/ directory and add an implementation for this route, like so:

import { Request, Response } from 'express';

export function businessPartners(req: Request, res: Response) {
  res.status(200).send('We will implement this in a minute');
}

The businessPartners function is a callback function that we will register for a specific route. It writes the status 200 and a placeholder message to the response.

Then, add this route to the routes of your application in application.ts (see // add the following line to your code):

private routes(): void {
  const router = express.Router();

  router.get('/', indexRoute);
  router.get('/hello', helloWorld);
  // add the following line to your code
  router.get('/business-partners', businessPartners);
  this.app.use('/', router);
}

Should your editor not offer you to automatically add the correct import, add the following line to your import statements:

import { businessPartners } from './business-partner-route';

You can start your application by running npm run start:local. Now, calling http://localhost:8080/business-partners should return our placeholder string.

Initially, the app only contains the index and hello-world routes. We will add another route for business-parters that will simply list all available business partners.

First, create a new file business-partner-route.js in the src/ directory and add an implementation for this route, like so:

function businessPartners(req, res) {
  res.status(200).send('We will implement this in a minute');
}

module.exports.businessPartners = businessPartners;

The businessPartners function is a callback function that we will register for a specific route. It writes the status 200 and a placeholder message to the response.

Then, add this route to the routes of your application in application.js (see // add the following line to your code):

private routes() {
  const router = express.Router();

  router.get('/', indexRoute);
  router.get('/hello', helloWorld);
  // add the following line to your code
  router.get('/business-partners', businessPartners);
  this.app.use('/', router);
}

Should your editor not offer you to automatically add the correct import, add the following line to your import statements:

const { businessPartners } = require('./business-partner-route');

You can start your application by running npm run start:local. Now, calling http://localhost:8080/business-partners should return our placeholder string.

Import the entity you want to make a call to into your application. In this tutorial we are importing the business partner entity of the business partner service. Add the following line to the top of the business-partner-route.ts.

import { BusinessPartner } from '@sap/cloud-sdk-vdm-business-partner-service';

Import the entity you want to make a call to into your application. In this tutorial we are importing the business partner entity of the business partner service. Add the following line to the top of the business-partner-route.js.

const { BusinessPartner } = require('@sap/cloud-sdk-vdm-business-partner-service');

In the business-partner-route create a function getAllBusinessPartners and implement it as follows:

function getAllBusinessPartners(): Promise<BusinessPartner[]> {
  return BusinessPartner.requestBuilder()
    .getAll()
    .execute({
      url: 'http://localhost:3000'
    });
}

• In line 1, we are creating a request builder for the business partner entity.
• Line 2 indicates, that we want to create a request to get all the business partners.
• Line 3 ff. takes care of the execution and sends a request to a url based on the given destination url.

In the code snippet above we assume that you have a mock server running locally. If you are using an actual SAP S/4HANA Cloud system, you can replace the third line with a different destination configuration:

.execute({
  url: '<URI of your SAP S/4HANA Cloud System>',
  username: '<USERNAME>',
  password: '<PASSWORD>'
})

To use the SAP API Business Hub sandbox for your requests, you will need to pass the API key to the VDM requests using the withCustomHeaders method, and you will need to add the correct URL to your destinations. Checkout the following example:

return BusinessPartner.requestBuilder()
  .getAll()
  .withCustomHeaders({ APIKey: '<YOUR-API-KEY>'})
  .execute({
    url: 'https://sandbox.api.sap.com/s4hanacloud'
  });
}

As network requests are asynchronous by nature, the return value of this function is a Promise to a list of Business Partners (Promise<BusinessPartner[]>).

Let’s add the execution of this request to the callback for our business-partners route by making the callback async and writing the resolved return value of the getAllBusinessPartners function to the response:

export async function businessPartners(req: Request, res: Response) {
  getAllBusinessPartners()
    .then(businessPartners => res.status(200).send(businessPartners))
    .catch(error => res.status(500).send(error));
}

Here is what your business-partner-route.ts should look like, if you are using the mock server:

import { BusinessPartner } from "@sap/cloud-sdk-vdm-business-partner-service";
import { Request, Response } from "express";

export async function businessPartners(req: Request, res: Response) {
  getAllBusinessPartners()
    .then(businessPartners => res.status(200).send(businessPartners))
    .catch(error => res.status(500).send(error));
}

function getAllBusinessPartners(): Promise<BusinessPartner[]> {
  return BusinessPartner.requestBuilder()
    .getAll()
    .execute({
      url: 'http://localhost:3000'
    });
}

Now restart your server and reload the http://localhost:8080/business-partners url to retrieve a list of business partners.

Congratulations, you just made your first call with the SAP Cloud SDK!

In the business-partner-route create a function getAllBusinessPartners and implement it as follows:

function getAllBusinessPartners() {
  return BusinessPartner.requestBuilder()
    .getAll()
    .execute({
      url: 'http://localhost:3000'
    });
}

• In line 1, we are creating a request builder for the business partner entity.
• Line 2 indicates, that we want to create a request to get all the business partners.
• Line 3 ff. takes care of the execution and sends a request to a url based on the given destination url.

In the code snippet above we assume that you have a mock server running locally. If you are using an actual SAP S/4HANA Cloud system, you can replace the third line with a different destination configuration:

.execute({
  url: '<URI of your SAP S/4HANA Cloud System>',
  username: '<USERNAME>',
  password: '<PASSWORD>'
})

To use the sandbox for your requests, you will need to pass the API key to the VDM requests using the withCustomHeaders method, and you will need to add the correct URL to your destinations. Checkout the following example:

return BusinessPartner.requestBuilder()
  .getAll()
  .withCustomHeaders({ APIKey: '<YOUR-API-KEY>'})
  .execute({
    url: 'https://sandbox.api.sap.com/s4hanacloud'
  });
}

As network requests are asynchronous by nature, the return value of this function is a Promise to a list of Business Partners (Promise<BusinessPartner[]>).

Let’s add the execution of this request to the callback for our business-partners route by making the callback async and writing the resolved return value of the getAllBusinessPartners function to the response:

async function businessPartners(req, res) {
  getAllBusinessPartners()
    .then(businessPartners => res.status(200).send(businessPartners))
    .catch(error => res.status(500).send(error));
}

module.exports.businessPartners = businessPartners;

Here is what your business-partner-route.js should look like, if you are using the mock server:

const { BusinessPartner } = require("@sap/cloud-sdk-vdm-business-partner-service");

async function businessPartners(req, res) {
  getAllBusinessPartners()
    .then(businessPartners => res.status(200).send(businessPartners))
    .catch(error => res.status(500).send(error));
}

module.exports.businessPartners = businessPartners;

function getAllBusinessPartners() {
  return BusinessPartner.requestBuilder()
    .getAll()
    .execute({
      url: 'http://localhost:3000'
    });
}

Now restart your server and reload the http://localhost:8080/business-partners url to retrieve a list of business partners.

Congratulations, you just made your first call with the SAP Cloud SDK!

function getAllBusinessPartners(): Promise<BusinessPartner[]> {
  return BusinessPartner.requestBuilder()
    .getAll()
    .execute({
      destinationName: 'MockServer'
    });
}

function getAllBusinessPartners() {
  return BusinessPartner.requestBuilder()
    .getAll()
    .execute({
      destinationName: 'MockServer'
    });
}