beckn / beckn/PULSE-Specification
[C4GT] Implement Beckn Protocol Sandbox Interface for ODR Use Cases
- Dominant language
- No language data
- Stars
- 3
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
# Project Details
[Beckn protocol](https://becknprotocol.io/) 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](https://ondc.org/) (ONDC), [Namma Yatri](https://nammayatri.in/) at Bangalore, [Kochi Open Mobility Network](https://openkochi.net/) (KOMN), [Unified Health Interface](https://uhi.abdm.gov.in/) (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
- Beckn protocol sandbox at : https://github.com/beckn/beckn-sandbox
## 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
- @ravi-prakash-v
- @faizmagic
- Keerthana (github username to be added in due course)
#### 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 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
Contributor guide
No contributing guide indexed for this repository
Research direction
No repository files, tests, or entry points are named. Start by reviewing the Beckn protocol and the existing beckn/beckn-sandbox, then confirm project setup with the listed mentors; done means an end-to-end simulation of typical ODR use cases, including the specified protocol endpoints and agent emulator.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, json, mongodb, node.js, openapi, typescript
- Domain
- api, backend, databases, distributed-systems
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100