Sending the fare products of a mobility service (Node.js)
In this use case, the user views the various fare products a mobility service provider offers. Fare products are various offerings on a particular service like "Monthly Pass", "Single Journey Adult Ticket", "Return Ticket", "Day Pass" etc. These fare products are usually represented as items of a mobility service catalog. Other examples include products like "Uber Go", "Uber X" etc
Code snippets
BPP receives protocol search
/*
Example Request JSON:
{
"context": {
"domain": "nic2004:60221",
"country": "IND",
"city": "std:080",
"action": "search",
"core_version": "0.9.1",
"bap_id": "https://mock_bap.com/",
"bap_uri": "https://mock_bap.com/beckn/",
"transaction_id": "1209849124",
"message_id": "12341242342",
"timestamp": "2021-03-23T10:00:40.065Z"
},
"message": {
"intent" : {
"fulfillment": {
"start" : {
"location" : {
"gps" : "12.9349377,77.6055586"
}
},
"end" : {
"location" : {
"gps" : "12.4535445,77.9283792"
}
}
}
}
}
}
*/
// Auth middleware authenticates the digital signature of the incoming request
router.post('/mobility/search', auth, search);
function search({ headers, body }, res) {
try {
const message = _.get(body, "message");
const context = _.get(body, "context");
if (!context) {
return res.status(400).send(httpResponse("NACK", "Missing Context"));
}
if (!message) {
return res.status(400).send(httpResponse("NACK", "Missing Message"));
}
// ... Returns the ack immediately and continue the processing after validation
res.status(200).send(httpResponse("ACK"));
processSearch(headers, body)
} catch (error) {
res.status(500).send(httpResponse("NACK", error));
}
};
BPP processes the search
function processSearch(requestHeaders, searchRequestBody) {
// Execute business logic here
let searchResponse = {
}
generateResponse(requestHeaders, searchResponse)
}
BPP generates response
async function generateResponse(requestHeaders, rawResponse){
/*
Example Request JSON :
{
"context": {
"domain": "nic2004:60221",
"country": "IND",
"city": "std:080",
"action": "on_search",
"core_version": "0.9.1",
"bap_id": "https://mock_bap.com/",
"bap_uri": "https://mock_bap.com/beckn/",
"bpp_id": "https://mock_bpp.com/",
"bpp_uri": "https://mock_bpp.com/beckn/",
"transaction_id": "1209849124",
"message_id": "12341242343",
"timestamp": "2021-03-23T10:00:40.065Z"
},
"message": {
"catalog": {
"bpp/descriptor": {
"name": "Mock BPP"
},
"bpp/providers": [
{
"id": "metro-one",
"descriptor" : {
"name": "Metro One"
},
"categories": [
{
"id": "monthly",
"descriptor": {
"name": "Monthly Pass"
}
},
{
"id": "day",
"descriptor": {
"name": "Day Pass"
}
}
],
"items": [
{
"id": "monthly_one_way",
"descriptor" : {
"name" : "One way monthly pass",
"images" : [
"https://mock_bpp.com/images/m1.jpg"
]
},
"category_id": "monthly",
"price" : {
"currency": "INR",
"value": "500"
},
"time": {
"range": {
"start": "2021-08-17T05:22:34.861Z",
"end": "2021-09-17T05:22:34.861Z"
}
},
"matched": true
},
{
"id": "monthly_two_way",
"descriptor" : {
"name" : "Two way monthly pass",
"images" : [
"https://mock_bpp.com/images/m2.jpg"
]
},
"category_id": "monthly",
"price" : {
"currency": "INR",
"value": "1000"
},
"time": {
"range": {
"start": "2021-08-17T05:22:34.861Z",
"end": "2021-09-17T05:22:34.861Z"
}
},
"matched": true
},
{
"id": "unlimited_day",
"descriptor" : {
"name" : "Unlimited Day Pass",
"images" : [
"https://mock_bpp.com/images/du.jpg"
]
},
"category_id": "day",
"price" : {
"currency": "INR",
"value": "200"
},
"time": {
"range": {
"start": "2021-08-17T05:22:34.861Z",
"end": "2021-08-18T05:22:34.861Z"
}
},
"matched": true
},
{
"id": "day_two_way",
"descriptor" : {
"name" : "Two way day pass",
"images" : [
"https://mock_bpp.com/images/d2.jpg"
]
},
"category_id": "day",
"price" : {
"currency": "INR",
"value": "50"
},
"time": {
"range": {
"start": "2021-08-17T05:22:34.861Z",
"end": "2021-08-18T05:22:34.861Z"
}
},
"matched": true
}
]
}
]
}
}
}
*/
//The below code generates the above example JSON.
let onSearchResponseBody = { }
//call protocol on_search
await callOnSearch(requestHeaders, onSearchResponseBody);
}
BPP calls protocol on_search
async function callOnSearch(requestHeaders, onSearchResponseBody) {
// Take the subscriber Id from the header and calls the registry to get the url. If already cached it need not to call again
const uri = await lookup(requestHeaders);
// Construct Header
const headers = constructAuthHeader(); // Auth Header with digital Signature
return axios({ url: `${uri}/mobility/on_search`, method: "POST", headers, data: onRatingResponseBody });
}