Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[C4GT] Implement Beckn Protocol Sandbox Interface for ODR Use Cases #1

Open
ravi-prakash-v opened this issue May 20, 2023 · 11 comments
Labels
good first issue Good for newcomers

Comments

@ravi-prakash-v
Copy link
Contributor

ravi-prakash-v commented May 20, 2023

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 ODR Interface is an API that emulates the behaviour of an Open Dispute Resolution 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 dispute resolution services
  • 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

What needs to be built

  • A fully functioning scalable ODR sandbox compliant to beckn protocol specifications
  • A bot that emulates dispute resolution agents for various ODR services

Learning Path

Complexity

Medium

Skills Required

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

Name of Mentors:

Product Understanding

Protocol Specification Design

Project Setup and Guidance

Product Setup

Product Architecture

Frontend Development

Backend Development

Deployment and Devops

Testing and QA

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 typical ODR use cases on a beckn ODR reference application

Out of Scope

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

Milestones

  • Understanding beckn protocol
  • Understanding dispute resolution ecosystem and use cases
  • Developing knowledge model for ODR ecosystem
  • ODR Knowledge model Adaptation to beckn 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 emulator for ODR agent
@ravi-prakash-v ravi-prakash-v added the good first issue Good for newcomers label May 20, 2023
@ravi-prakash-v ravi-prakash-v changed the title Create Sandbox [C4GT] Create Beckn Protocol Sandbox for ODR Use Cases May 20, 2023
@ravi-prakash-v ravi-prakash-v changed the title [C4GT] Create Beckn Protocol Sandbox for ODR Use Cases [C4GT] Implement Beckn Protocol Sandbox Interface for ODR Use Cases May 20, 2023
@Mohit-Aasirwal
Copy link

Hi!
I would love to explore this project more...

@abhibamnote
Copy link

Hi!
@faizmagic @hemant-eminds @nikhil2128 @ujjwal502 I would like to know more about this project.

@Flanker-shyam
Copy link

Greetings mentors,

This is Shyam Sunder, I found Beckn protocols and its working super exciting, the idea is big and intuitive, the idea of shifting online dispute resolution on the ONDC network is a very effective step by our government and It will be a great opportunity for me to contribute on such a growing tech.

As I am a Beckend developer and I work with javascript, Nodejs and mongoDB the tech stacks of this project suits me and I would love to work on this project.

Regards,
Shyam Sunder
Github profile

@Flanker-shyam
Copy link

Flanker-shyam commented Jun 1, 2023

@ravi-prakash-v @faizmagic @hemant-eminds @nikhil2128 @ujjwal502

Here is my understanding for this project, kindly correct me If I am wrong,

The way other sandboxes working, like that of mobility, we need to create one for ODR also, In which we need to understand the use cases of the ODR field and then Implement them.

Like one of the common use case of ODR will be to find the ODR services and the portals, In that case I need to change the fields in search end point, like what will be the context in the scenario and the message field of the same, then In BAP side, we need to modify in similar way that what data we are going to send, first to the BG and then to the BAP..

like it is implemented here !

@HarshPanchal26
Copy link

@Flanker-shyam Surely you must explain very well , but can you please explain bit more about , what is this project about , scope etc . because I am new to this , I didn't get it yet .

@HarshPanchal26
Copy link

@ravi-prakash-v @abhibamnote @Flanker-shyam @Mohit-Aasirwal Can you please guide me for set this project locally.

@Flanker-shyam
Copy link

@Flanker-shyam Surely you must explain very well , but can you please explain bit more about , what is this project about , scope etc . because I am new to this , I didn't get it yet .

Yeah sure @HarshPanchal26 let's discuss it, you can DM me on discord here at Flanker^Shyam#6675

@dhirajshettyyy
Copy link

@abhibamnote @Mohit-Aasirwal @Flanker-shyam @HarshPanchal26 ,
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

@HarshPanchal26
Copy link

@Flanker-shyam I text you on

@Flanker-shyam Surely you must explain very well , but can you please explain bit more about , what is this project about , scope etc . because I am new to this , I didn't get it yet .

Yeah sure @HarshPanchal26 let's discuss it, you can DM me on discord here at Flanker^Shyam#6675

Yes @Flanker-shyam I send DM you on discord , Can you check it ,and we can start working on it.

ravi-prakash-v pushed a commit that referenced this issue Sep 23, 2023
@ravi-prakash-v
Copy link
Contributor Author

@emmayank please add the PULSE sandbox link with instructions on how to use it to the README.

@emmayank
Copy link
Collaborator

emmayank commented Dec 6, 2023

@ravi-prakash-v , I am done with the changes and raised the PR.

emmayank added a commit that referenced this issue Dec 6, 2023
Update on_search-request.json
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

7 participants