[C4GT] Implement Beckn Mobility Sandbox Interface

[ravi-prakash-v]

Project Details

Beckn protocol is a set of open specifications aimed to create a common language, that is machine-readable and enables interoperability for economic transactions between disparate platforms of any size and form - be it a cab reservation, or booking a stay, or confirming a doctor’s appointment, and many more. Thus it enables the creation of inclusive and equitable open networks offering a multitude of choices to the citizens, while at the same time negating the dependence on intermediaries to freely operate and generate economic transactions of value. It is akin to what SMTP is to E-mails or HTTP is to the Internet.

Since its inception in 2019 as a set of specifications, Beckn has been adopted across geographies in sectors such as mobility, retail, hyperlocal logistics, healthcare, skills, agriculture sectors, etc. Few notable examples of open networks built on the Beckn protocol are Open Network for Digital Commerce (ONDC), Namma Yatri at Bangalore, Kochi Open Mobility Network (KOMN), Unified Health Interface (UHI), etc.

The Beckn Mobility Interface is an API that emulates the behaviour of an Open Mobility Network. BAPs can build rich integrated experiences by combining services offered by multiple BPPs on the network. BPPs can build complex products by analyzing the nature of input from multiple BAPs. This is an important step in the set up and expansion of open networks. Businesses can test their implementations for protocol compliance by plugging into this sandbox.

Features to be implemented

• Beckn-protocol compliant catalogs across multiple mobility services like ride hailing, rental, public transit etc.
• BPP endpoints : search, select, init, confirm, status, update, track, cancel, rating, support
• BAP endpoint : on_search, on_select, on_init, on_confirm, on_status, on_update, on_track, on_cancel, on_rating, on_support
• BG endpoint : search
• Registry endpoints : lookup

What exists

• Beckn protocol sandbox at : https://github.com/beckn/beckn-sandbox
• Beckn protocol mobility specifications at : https://github.com/beckn/mobility

What needs to be built

• A fully functioning scalable mobility sandbox compliant to beckn protocol specifications

Learning Path

Complexity

Medium

Skills Required

• Open API 3.0
• JSON Schema
• NodeJS
• JavaScript
• TypeScript
• MongoDB

Name of Mentors:

Product Understanding

• @ravi-prakash-v
• @faizmagic

Protocol Specification Design

• @ravi-prakash-v

Project Setup and Guidance

• @faizmagic
• @hemant-eminds
• @nikhil2128
• @ujjwal502

Product Setup

• @nikhil2128
• @ujjwal502

Product Architecture

• @ravi-prakash-v
• @nikhil2128

Frontend Development

• @ujjwal502

Backend Development

• @nikhil2128
• @emindsajay
• @zoyaashik

Deployment and Devops

• @prasad-takale-eminds

Testing and QA

• @SushanthKJ

Project size

8 Weeks

Project Setup Guide

To set up this project, please connect with the Project Setup and Guidance mentor for this project and follow their instructions

Product Set Up

To set up this project, please connect with the Product Setup and Guidance mentor for this project and follow their instructions

Acceptance Criteria

• End-to-end simulation of a ride hailing use case on a beckn mobility reference application
• End-to-end simulation of a ride hailing use case on a Namma Yatri staging application
• End-to-end simulation of a ride hailing use case on a Namma Yatri partner staging application
• End-to-end simulation of a ride hailing use case on a beckn mobility driver reference application

Out of Scope

• UI development, (however contributions to existing UI implementations are welcome)

Milestones

• Understanding beckn protocol
• Understanding beckn mobility protocol
• Development of search / on_search API
• Development of select / on_select API
• Development of init / on_init API
• Development of confirm / on_confirm API
• Development of status / on_status API
• Development of update / on_update API
• Development of track / on_track API
• Development of cancel / on_cancel API
• Development of rating / on_rating API
• Development of support / on_support API
• Creation of Driver emulator

[Aatyagi]

I would like to contribute to this issue . Your project is a part of GovTech 23 right ? and if it is so before initiating the work i need to submit a proposal if i am not wrong

[SohamRatnaparkhi]

Hello mentors,
Soham Ratnaparkhi here.
I am extremely enthusiastic about the opportunity to learn and contribute to Beckn. I am confident that my skills and experience make me a strong candidate to make meaningful contributions to this project.
Looking forward to submitting a proposal for this project.
Thank you!

[RaghhavDTurki]

Greetings mentors!
I am Raghhav D Turki, a 3rd-year undergraduate from IIIT Kota. I am excited about this project as I find the Beckn protocol extremely interesting and the tech stack required falls right under my area of expertise. After thoroughly reviewing the provided materials, I am eager to set up the project on my local computer, so can you help me with the same? @nikhil2128 @ujjwal502 @ravi-prakash-v

Looking forward to submitting my proposal for the same and collaborating with you in the future.
Thanks

[AtmegaBuzz]

Hello Mentors, really excited to submit a proposal in this project :)

[Himanshu-Dedha]

Hello, @ujjwal502 I've gone through the documentation and also set up the project locally on my system. My question is how do I proceed further with the project? The beckn protocol sandbox contains API specifications for ride hailing and public transit, are we supposed to add more APIs for more mobility services?

[crudybagger]

@ravi-prakash-v Are the Meta APIs out of scope too ?

[Sahilparyani1804]

Hello mentors,
Sahil Paryani here.
I am excited to contribute and learn about Beckn. I am confident that my skills and experience make me a strong candidate to make meaningful contributions to this project.
Thank you!

[dhirajshettyyy]

@crudybagger @AtmegaBuzz @RaghhavDTurki @Himanshu-Dedha @Sahilparyani1804 @SohamRatnaparkhi @Aatyagi ,
It's great to see your interest in this project, you can make an active contribution via issue creation and by submitting your Pull Requests.

For support from fellow contributors, Join Beckn Open Collective server:https://bit.ly/bocWebInvite