Skip to content

chore: lookup v2.0 added #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sandeepshahi merged 2 commits into from
Apr 14, 2025
Merged

chore: lookup v2.0 added #79

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
893da4b
chore: lookup v2.0 added
nishthamongaondc Apr 11, 2025
f473ffb
fix: lookup v2.0 url for preprod
nishthamongaondc Apr 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 48 additions & 14 deletions registry/Onboarding of Participants.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,31 +154,52 @@ https://prod.registry.ondc.org/subscribe
```

13. Check your record in registry lookup
> 1. /lookup

> 1. **/v2.0/lookup** (Recommended)

```
# For Staging
https://staging.registry.ondc.org/lookup
https://staging.registry.ondc.org/v2.0/lookup

# For Pre-prod
https://preprod.registry.ondc.org/ondc/lookup
# For Pre-Prod
https://preprod.registry.ondc.org/v2.0/lookup

# For PROD
https://prod.registry.ondc.org/lookup
https://prod.registry.ondc.org/v2.0/lookup
```

The new version supports secure access using Authorization headers.

```
curl --location 'https://prod.registry.ondc.org/v2.0/lookup' \
--header 'Content-Type: application/json' \
--header 'Authorization: Signature keyId="example-bap.com|bap1234|ed25519", algorithm="ed25519", created="<timestamp>", expires="<timestamp>", headers="(created)(expires)digest", signature="<signature>"' \
--data '{
"country": "IND",
"domain": "ONDC:RET10"
}'
```
curl --location --request POST 'https://preprod.registry.ondc.org/ondc/lookup' \
--header 'Content-Type: application/json' \
--data-raw '{

"country": "IND",
"domain":"ONDC:RET10"
### Useful References

- [Signing & Verification Process](https://github.com/ONDC-Official/developer-docs/blob/main/registry/signing-verification.md)
- [Reference Utility - Signing & Lookup](https://github.com/ONDC-Official/reference-implementations/tree/main/utilities/signing_and_verification)
- [SwaggerHub - Registry Lookup API](https://app.swaggerhub.com/apis/ONDC/ONDC-Registry-Onboarding/2.1.0#/ONDC%20Network%20Participant%20Onboarding/post_v2_lookup)

> 2. **/lookup** (To be deprecated)

}'
```
>2. /vlookup
# For Staging
https://staging.registry.ondc.org/lookup

# For Pre-prod
https://preprod.registry.ondc.org/ondc/lookup

# For PROD
https://prod.registry.ondc.org/lookup
```

> 3. **/vlookup** (To be deprecated)

```
# For Staging
Expand All @@ -190,7 +211,6 @@ https://preprod.registry.ondc.org/ondc/vlookup
# For PROD
https://prod.registry.ondc.org/vlookup
```

```
curl --location 'https://preprod.registry.ondc.org/ondc/vlookup' \
--header 'Content-Type: application/json' \
Expand All @@ -214,6 +234,20 @@ https://prod.registry.ondc.org/vlookup
- signature: search_parameters signed using private key of request initiator: sign(country|domain|type|city|subscriber_id) => - sign(IND|ONDC:RET10|sellerApp|std:080|ondc.org)
- type: enums are "buyerApp", "sellerApp", "gateway"

```

Note: If the API rate limit is exceeded, you may receive HTTP 429 responses. Recommended registry limits:

| Endpoint | Limit |
|-------------------------|-----------|
| `/subscribe` | 10 RPM |
| `/lookup` | 7600 RPM |
| `/vlookup` | 2100 RPM |
| `/search` | 2100 RPM |
| `/v2.0/lookup` | TBD |

Ensure that your systems are rate-limit aware and gracefully handle retries.

```
14. In case you are not able to find your record in lookup and vlookup, please report to techsupport@ondc.org

Expand Down