ONEST Starter Pack
  • Introduction
    • ONEST- Focus Areas
    • Core Principles
    • Roles You Can Play
  • Join the network
  • Network Observability
    • Introduction
    • Telemetry Implementation
    • Transaction Dashboard
  • Learn
    • Beckn Protocol - Video Library
      • Chapter 1: Open Networks as a Digital Marketplace
      • Chapter 2: Beckn – An open protocol for decentralized commerce
      • Chapter 3: Beckn Ecosystem Architecture
      • Chapter 4: Specification and Support Layer
      • Chapter 5: Transaction Layer
      • Chapter 6: Implementing Beckn Protocol
      • Chapter 7: Network Topologies
      • Chapter 8: Beckn API Overview
      • Chapter 9: Example of a Retail Transaction
      • Chapter 10: Example of a Logistics Transaction
      • Chapter 11: Example of a Transaction using Interactive UI
    • Getting started on DSEP - Video Library
      • Chapter 1: Understanding Challenges in the Ecosystem
      • Chapter 2: Open Networks for Skilling and Education
      • Chapter 3: DSEP Overview
      • Chapter 4: DSEP Specification and Network Architecture
      • Chapter 5: DSEP APIs
      • Chapter 6: DSEP Schema
      • Courses and Training Transaction Workflow
      • Mentorships and Coaching Transaction Workflow
      • Scholarships and Grants Transaction Workflow
      • Internships and Jobs Transaction Workflow
    • Reference Implementation Guides
      • Financial Support (DSEP 1.0)
      • Skilling Experience (DSEP 1.0)
        • Course with scholarship
      • Work Opportunities (DSEP 2.0)
      • Suggested Form Structure for xInput
    • Understanding the APIs
    • Developing the APIs
      • Work Opportunities (DSEP 2.0)
      • Financial support, Skilling (DSEP 1.0)
    • Integration of Adaptors
      • Protocol Server
        • Introduction & Features
        • Architecture
        • Installation
        • Testing
        • Generate Keys
        • Local Tunnelling and Nginx Setup
        • FAQs
      • Job Manager
      • Profile Manager
      • AI Matching Engine
  • Community
    • Contribution Guide
    • Discussion Forum
    • Cohort calls
    • Issues Board
  • HELP
    • FAQs
Powered by GitBook
On this page
  • Introduction
  • Example
  • Reference

Was this helpful?

Edit on GitHub
  1. Learn

Understanding the APIs

Last updated 5 months ago

Was this helpful?

Introduction

ONEST Protocol layered architecture is illustrated as shown in the diagram below. The base layer refers to the , which is an open source decentralized protocol. Over the base layer, the network extension layer comprises the API contracts customized to the ONEST context, along with other specs that have been adopted in order to facilitate transactions in the network.

Here is an overview to help you visualize the mapping between transactional flow and the APIs as part of ONEST protocol.

Example

Below is the example usage of protocol APIs in ONEST Learning Experiences Domain.

API
Usage

Search API

Discover the courses

On Search API

Returns the course catalogue

Select API

Select the course and get quote

On Select API

Returns the complete course details along with quote

Init API

Initialize the course subscription

On Init API

Send order details with payment terms

Confirm API

Confirm the course subscription

On Confirm API

Send course content details (like video player, PDF etc)

Status API

Request the course consumption status

On Status API

Returns the course consumption status

Rating API

Provide rating for the course, course provider etc

On Rating API

Acknowledge rating

Refer to Reference Implementation Guidesto understand APIs usage in other ONEST domains (Learning Experience, Financial Support, Work Opportunities and Expert Connect).

Reference

ONEST network is an implementation of the DSEP protocol, which is based on the Beckn protocol.

  • Understand DSEP Protocol:

Refer to for more details about the APIs.

Beckn Protocol APIs Specification:

Understand Beckn protocol:

DSEP Tech Overview Videos:

Beckn Protocol Specification
https://developers.becknprotocol.io/docs/core-specification/core-apis/
https://developers.becknprotocol.io/docs/introduction/video-overview/
https://dsep.sunbird.org/
HERE
Beckn Protocol