SAP Integration Application Guide

This guide outlines the integration process for incorporating SAP records into NextBillion's Route Optimization API using the Retool development suite.

Step 1: SAP Records Retrieval

To retrieve customer records and their address details from SAP, execute the following cURL command:

1
# Fetch customer data from SAP
2
curl --location 'https://sandbox.api.sap.com/s4hanacloud/sap/opu/odata4/sap/api_freightorder/srvd_a2x/sap/freightorder/0001/FrtOrdStopLocAddrDfltRprstn?%24top=50' \
3
--header 'APIKey: <SAP_API_Key>' \
4
--header 'Accept: application/json' \
5
--header 'DataServiceVersio: 2.0' 

The response will contain an array of customer records with address details in JSON format.

1
{
2
  "@odata.context": "$metadata#FrtOrdStopLocAddrDfltRprstn",
3
  "@odata.metadataEtag": "W/"20231014225153"",
4
  "value": "[...]"
5
}

The subsequent cell visualizes the above API response.

Step 2: Vehicle Records

In this integration, we employed randomly generated vehicles. The CSV-formatted details of these vehicles were uploaded to the Database and leveraged for optimization. Users have the flexibility to integrate their own fleet/vehicle records into the optimization process. If vehicle records are available in SAP, they can be seamlessly pulled and incorporated into the optimization workflow.

The following image visualizes the vehicles dashboard.

Step 3: Integration with Route Optimization API

Following the successful retrieval of essential data from SAP, seamlessly integrate the fetched information with Route Optimization using the specified API endpoint. Effectively map the SAP data to the relevant API parameters and configure optimization settings, including shift start and end times, as well as service times.

This code snippet manages the integration process, ensuring a smooth connection between SAP data and Route Optimization API.

1
//Initialization
2
let vehicles = [];
3
let shifts = [];
4
let starts = [];
5
let ends = [];
6
let veh_attr = [];

Step 4: Create Optimization Jobs

Initiate the creation of optimization jobs by sending a POST request to NextBillion.ai's Route Optimization API with specified parameters. Confirm the successful job creation through the received API response.

Here's an example of the POST query using cURL:

1
curl --request POST \
2
    --url https://api.nextbillion.io/optimization/v2?key={{localStorage.values.apiKey}}

Upon successful execution, the API response will confirm the creation of the optimization job:

1
{
2
  "id": "daa1725f45c6c1e9aa184dca568d596c",
3
  "message": "Optimization job created",
4
  "status": "Ok"
5
}

This response provides essential information, including the job ID, a confirmation message, and the status 'Ok,' indicating the successful creation of the optimization job.

Step 5: Optimized Route Result Retrieval

Retrieve the optimized route result by making a GET request to the NextBillion.ai Route Optimization API with the job ID and API key.

Below is an example of the GET query:

1
https://api.nextbillion.io/optimization/v2/result?id={{nbaiOptimizationRun.data.id}}&key={{localStorage.values.apiKey}}

Upon successful retrieval, the API responds with a JSON structure, providing crucial details about the optimized route. Here's an example of the JSON response:

1
{
2
  "result": "{...}",
3
  "status": "Ok",
4
  "message": ""
5
}

This response includes detailed information such as total cost, the number of routes, service and duration metrics, and individual steps for each route, offering a comprehensive overview of the optimized route result.

Step 6: Visualize Optimized Routes

After successfully fetching the data and setting up the Route Optimization API, initiate the API to generate optimized routes. To visualize the generated routes, you can view them on NextBillion's Optimizer using the following link:

1
https://playground.nextbillion.ai/optimization-tester?apiKey={{localStorage.values.apiKey}}&requestID={{nbaiOptimizationRun.data.id}}

This link directs you to the Optimizer interface, providing a convenient way to inspect and analyze the optimized routes generated by the Route Optimization API. Simply replace the placeholders with your API key and the request ID obtained from the API response for seamless integration and route assessment.

Below is a snippet showcasing the visual representation of the generated routes within the tester interface.

Step 7: Retrieve Optimization Results in SAP

To access the outcome of the optimization process within the SAP system, employ a GET request. In your SAP instance, craft a GET request with the specified details:

1
curl -X GET "https://api.openconnectors.trial.ap21.ext.hana.ondemand.com/elements/api-v2/optimization/v2/result?id=<Optimization Result ID>&key=<NextBillion.ai API Key>" -H "accept: application/json" 
2
-H "Authorization: User <User Secret of SAP>=, Organization 359ad019a15fd3e02f4353c53a489827, Element w8SQ6cP+l4qBgFpbcHd/mMIoorCZUYiiEu0KxrYY/QM="

This request will retrieve the optimization results from NextBillion.ai and integrate them seamlessly into your SAP environment. Ensure that you replace <Optimization Result ID> and <NextBillion.ai API Key> with the corresponding values for your specific optimization run.

Upon successful execution, the JSON response within SAP will contain the detailed optimization results, providing valuable insights into the routes and associated data generated by the optimization process.

SAP, with its extensive capabilities, offers a multitude of integration possibilities. This guide outlines one approach to seamlessly integrate SAP with NextBillion's Route Optimization API. While the SAP Integration Suite provides a robust toolkit for integrating diverse applications and systems, it's essential to note that it's not the sole method for integration. There are alternative methods and technologies available, and the choice depends on your specific SAP system.

Selecting the appropriate integration method hinges on your unique requirements and existing infrastructure. SAP offers a range of options to cater to various integration scenarios, allowing you to choose the approach that aligns best with your needs.