Steps for Go Live: Provider Platform
This document highlights the steps to be followed by a provider platform for technical integration on the ONEST network in order to go live with their offerings. The first cohort within the ONEST network will go live with the discovery stage of the transaction. Discovery, Trust & Transact (Select, Order, Confirm, Fulfill, Post-fulfilment) are the three stages of an end-to-end transaction. Thus, post following the steps highlighted in the document, every provider platform will be able to make their offerings discoverable across seeker platforms present within the ONEST network. For any further steps within a transaction, the consumers will be routed to the respective provider platform.
Step 1: Identify key use cases and user stories to start with, following an MVP for go-live on the ONEST network
- Example use case: There is an organisation A that creates a diverse range of educational content that is helping simplify K-12 education for students from all backgrounds. They upload this content on their own platform. Another organisation or individual looking for K-12 educational content need to find out about organisation A, visit their platform and search for the content based on the name, grade, subject and so on. But organisation A need more organisations and individuals to make use of this content. Thus, their key use case will be the discovery of educational courses hosted on their platform across all the seeker platforms on the ONEST network.
Step 2: Understand the APIs and the structures from the specifications and examples
Step 3: List down the data points that need to be shared as a response to a search request
- For example: Let’s take the example of the same organisation as highlighted in step 1. If there is a search request for a 9th grade math lesson from a seeker platform on the network. The organisation might want to respond back with the name of the course available with them pertaining to that lesson, the link to the course, an image/ thumbnail visually representing it and the name of the instructor or the organisation.
Step 4: Map the data points against the on_search API call Examples to help with the mapping:
- on_search for courses:
- on_search for scholarships:
Step 5: Register in the sandbox via the Network Participant form #Please note that the link to the Network Participant form will be added here shortly
Step 6: Integrate On_search API via Postman collection
Step 7: Test with reference seeker platforms (BAPs) on the sandbox
- Hosted versions of the provider platform (BPP) and Seeker platform (BAP) can be used to test the implementations. Link for the hosted version for a Provider platform (BPP): https://sandbox-bpp-network.becknprotocol.io
Step 8: Demo the end-to-end flow
Step 9: Implement signatures and validation as per spec.
- Guide to integrating to beckn Gateway:
- sample code on generation of keys, signing and verification:
- Beckn Registry Documentation:
- Codes to be used for generating a pair of private key, public keys: