Skip to content

beckn-on-succinct/ondc-retail-sdk-java

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ondc-retail-sdk-java

Java SDK for ONDC Retail Domain

This repo defines ONDC (Open Network for Digital Commerce) Retail Specification and also implements several utility functions. Java based SellerApp or BuyerApp can consume this. This SDK is agnostic of any Java based application frameworks.

Version

The ONDC Retail specification version that this SDK confirms to : 1.0. (Minor version - 1.0.28)

The Beckn/FIDE version that this SDK version consumes : 0.9.3 (repo)

Getting Started

The SDK will be published as Maven artifact soon. Consuming this SDK in your project is very straight forward, follow the steps below-

  • Clone this repo.
  • Run
  cd <repo-dir>
  mvn clean install
  • Add following as maven dependency to the project where this SDK is to be consumed,
  <dependency>
        <groupId>in.succinct.beckn.ondc</groupId>
        <artifactId>ondc-retail-sdk-java</artifactId>
        <version>[1.0-SNAPSHOT,)</version>
  </dependency>

The SDK can be used to build both BAP and BPP, and if you are building a BPP, It is hightly encouraged that you also consider bpp.shell project, it brings up an ONDC BPP with several features already built in (as per below), and you can start testing your app on staging in a matter of few hours.

  • Registry subscription
  • Crypto keys management
  • Async callback framework
  • Adaptors for various popular ecommerce platforms/tools and a framework if you want to build your own adaptor.

Contribution

ONDC is an open network, and the primary purpose of this SDK is to save effort to maintain and manage specification version revisions from a single place.

Hence, contributions to this SDK are most welcome.

Please feel free to raise Issues, Pull Requests, Contributor requests, Discussion topics.

Releases

No releases published

Packages

No packages published

Languages