Exercise: Querying SAP APIs in a JavaScript Program

On your laptop, in the File Explorer, create a project folder with name js-call-api (if you are in the SAP training system, use D:\workspace\js-call-api. Extract the js-call-api-initial.zip archive [download] to the project folder.

Open the project folder using Visual Studio Code.

1. Open Windows File Explorer and navigate to the folder.

2. Right-click and execute Open with Code.

Review the application files.

1. Open the app.js file and review the content.

2. Open the package.json file and review the content. In the file, a start script is defined.

3. Open the .vscode/launch.json file and review the content. It contains a run configuration launching the app.js script.

Set a breakpoint at line 1 of the app.jsfile. Make the application run and stop at the breakpoint. Continue execution. Remove the breakpoint.

1. In the app.js file, select line number 1. A breakpoint is created and a red dot appears.

2. Choose F5 (Run → Start Debugging). Follow the text in the Debug Console: the program starts in debug mode and stops at the breakpoint.

3. Choose Step Over (F10). The execution advances one line.

4. Choose Continue (F5). The execution continues to the end. Hello World! appears in the Debug Console.

5. In the app.js file, select the red dot beside line number 1. The breakpoint is deleted.

Open SAP Business Application Studio, open the training development space.

1. In your Web browser (for example, Google Chrome), open https://account.hanatrial.ondemand.com. If requested, enter your user and password.

2. Choose SAP Business Application Studio.

3. Enter the training development space.

In SAP Business Application Studio, create a new project folder named js-call-api, open it as a workspace, import in it the content of the js-call-api-initial.zip[download] archive.

1. Choose File → Open Workspace... (Ctrl+Alt+W), choose the projects folder and choose Open.

2. In the Projects tab, right-click and create a sub folder with the name js-call-api.

3. Choose File → Open Workspace... (Ctrl+Alt+W), choose the projects/js-call-api folder and choose Open.

4. In the js-call-api tab, right-click and choose Upload Files..., browse to the js-call-api-initial.zip[download] file, choose Open.

5. Choose Terminal → New Terminal. A terminal window appears in the lower part of the screen.

6. In the terminal, execute the following command:

   Code snippet

   Copy code

   unzip *.zip

   Copy code

   The archive content is extracted to the local folder. Execute the following command to remove the archive:

   Code snippet

   Copy code

   rm *.zip

   Copy code

In SAP Business Application Studio, set a breakpoint at line 1 of the app.jsfile. Make the application run and stop at the breakpoint. Continue execution. Remove the breakpoint.

1. In the app.js file, select line number 1. A breakpoint is created and a red dot appears.

2. Choose F5 (Run → Start Debugging). Follow the text in the Debug Console: the program starts in debug mode and stops at the breakpoint.

3. Choose Step Over (F10). The execution advances one line.

4. Choose Continue (F5). The execution continues to the end. Hello World! appears in the Debug Console.

5. In the app.js file, select the red dot beside line number 1. The breakpoint is deleted.

Look for the Business Partner Service documentation and review it.

1. In your Web browser, open http://help.sap.com/viewer/product/SAP_CLOUD_SDK

2. Go to Develop → Latest Version of JSDoc

3. In the Modules list look for the module containing the business partner service: vdm/business-partner-service.

In the Visual Studio Code or SAP Business Application Studio, modify and run the project so that the app.js program reads the Business Partners with last name Smith. For every business partner, read the following information:

1. In the package.json file, add the following dependencies:

   Code snippet

   Copy code

   "@sap-cloud-sdk/core": "^1.54.0",  
   "@sap/cloud-sdk-vdm-business-partner-service": "^1.28.2"

   Copy code

   For any problem, you can replace the content of the whole package.json file with the content of the js-call-api-2-package-json.txt file [download] , provided in the exercise files.

   Note

   You can check for further versions of this package at https://www.npmjs.com/package/@sap-cloud-sdk/core and https://www.npmjs.com/package/@sap/cloud-sdk-vdm-business-partner-service

2. Choose Terminal → New Terminal. In the terminal, execute the following command:

   Code snippet

   Copy code

   npm install

   Copy code

   The node packages indicated in the dependencies are downloaded to the node_modules folder.

3. Open the app.js file and enter the following code (replace the content of the whole app.js file with the content of the js-call-api-2-app-js.txt[download] file, provided in the exercise files, then replace >>>YOUR API KEY<<< with your own API Key. To get your API Key, open https://api.sap.com/api/API_BUSINESS_PARTNER, then Log On and choose Show API Key):

   Code snippet

   Copy code

   const bps = require('@sap/cloud-sdk-vdm-business-partner-service');
   
   // Create destination
   dest = {
       url: "https://sandbox.api.sap.com/s4hanacloud"
   };
   
   // Create request
   req = bps.BusinessPartner
       .requestBuilder()
       .getAll()
       .select(
           bps.BusinessPartner.BUSINESS_PARTNER,
           bps.BusinessPartner.FIRST_NAME,
           bps.BusinessPartner.LAST_NAME,
           bps.BusinessPartner.TO_BUSINESS_PARTNER_ADDRESS
               .select(
                   bps.BusinessPartnerAddress.ADDRESS_ID,
                   bps.BusinessPartnerAddress.COUNTRY,
                   bps.BusinessPartnerAddress.CITY_NAME
               )
       )
       .filter(
           bps.BusinessPartner.LAST_NAME.equals("Smith")
       )
       .addCustomHeaders(
           { apikey: '>>>YOUR API KEY<<<' });
   
   // execute request
   req.execute(dest)
       .then(
           // success
           function (result) {
               console.log(JSON.stringify(result, null, '\t'));
           },
           // error
           function (error) {
               console.log("Error: " + error.message);
           }
       );

   Copy code

4. In the package.json file, a grey Debug control appears just before the scripts definition. Choose Debug → start node app.js. A terminal window is opened and the program is executed. The extracted business partner information appears in the window.

Modify the project to query your S/4HANA Cloud system, which is accessible via the following information (replace ### with your user number, replace the URL with the one of your SAP S/4HANA Cloud tenant):

Information	Value
URL	Your S/4HANA Client tenant URL, for example https://my000000.s4hana.ondemand.com
Service user name	ADDRESS_MANAGER_###
Password	WelcomeToTheClouds1!

Note

As a prerequisite, for this API to be accessible in the S/4HANA Cloud tenant, you need to execute the previous exercise: Activating the APIs in SAP S/4HANA Cloud.

1. In the app.js program, change the system information in the following lines (replace ### with your user number, replace the URL with the one of your SAP S/4HANA Cloud tenant):

   Code snippet

   Copy code

   dest = {
       url: "https://sandbox.api.sap.com/s4hanacloud"
   };

   Copy code

   with the following new values:

   Code snippet

   Copy code

   dest = {
       url: 'https://my000000.s4hana.ondemand.com',
       username: 'ADDRESS_MANAGER_###',
       password: 'WelcomeToTheClouds1!'
   };

   Copy code

   You can optionally remove the statement that includes the apikey in the request headers (ensure not to delete the final semicolon):

   Code snippet

   Copy code

   .addCustomHeaders(
           { apikey: >>>YOUR API KEY<<' })

   Copy code

   You can copy the content of the whole app.js program from the js-call-api-3-app-js.txt file [download].

2. In the package.json file, a grey Debug control appears just before the scripts definition. Choose Debug → start node app.js. A terminal window is opened and the program is executed. The extracted business partner information appears in the window.