For the complete documentation index, see llms.txt. This page is also available as Markdown.

Getting started

This guide shows a consumer application (consumer node) how to connect to an NFH fabric DISCOVR instance and run its first discover request.

This guide shows a consumer application (consumer node) how to connect to an NFH fabric DISCOVR instance and run its first discover request.

Looking to run DISCOVR rather than call it? See Deploying Your Own Discover.

Prerequisites

Before you can call discover, you need:

Item
Description

DISCOVR base URL

The hostname of the DISCOVR instance you are integrating with (e.g. https://discovery.yourdomain.com)

bapId

Your consumer (consumer node) identifier, as registered on the network

bapUri

Your publicly reachable callback URL — DISCOVR delivers on_discover results here

Signing key

An Ed25519 key pair registered against your bapId for Beckn HTTP Signature authentication

networkId

The identifier of the network you want to search within

Step 1 — Prepare your callback endpoint

Discovery is asynchronous: DISCOVR acknowledges your request immediately, then delivers results to your bapUri via POST /on_discover. Your application must expose an endpoint that:

  • Accepts POST /on_discover with the result payload (see Usage)

  • Correlates the response to your request using messageId / transactionId

  • Returns an ACK

Step 2 — Send a discover request

Send your search intent to POST /discover on the DISCOVR base URL, signed with your Beckn HTTP Signature.

DISCOVR responds synchronously with an ACK:

Step 3 — Receive results

Shortly after the ACK, DISCOVR delivers matching catalogues, resources, and offers to your bapUri as an on_discover callback. See Usage for the response shape and Examples for more search modes.

Postman Collection

A Postman collection and environment files are available in the NFH fabric Discovery Service repository (api-collection/) to help you try requests against local, dev, and production instances.

Last updated

Was this helpful?