devsofttech_hms_ci4/.agents/skills/abdm-gateway/references/integrate.md

1.4 KiB

Integrate Gateway, sessions and the bridge registry

The calls themselves: where they live, what they need in their headers, and one request written out in full.

Hosts

  • https://dev.abdm.gov.in ABDM gateway, sandbox
  • https://apis.abdm.gov.in ABDM gateway, production

Endpoints

4 operations, grouped by the journey they belong to.

Other operations

Method Path What it does
GET /api/hiecm/gateway/v3/bridge-service/serviceId/{service-id} Fetch the details of a service ID.
GET /api/hiecm/gateway/v3/bridge-services Fetch the service ids registered against a bridge.
PATCH /api/hiecm/gateway/v3/bridge/url Update the bridge URL.
POST /api/hiecm/gateway/v3/sessions Generate access token.

Headers

Header What it is
REQUEST-ID Unique UUID for track the end to end request transaction
TIMESTAMP Actual time of the request was initiated, ISO 8601 represents date and time by starting with the year, follow…
X-CM-ID Suffix of the consent manager to which the request was intended

A request, in full

curl --request GET \
  --url https://dev.abdm.gov.in/api/hiecm/gateway/v3/bridge-service/serviceId/{service-id} \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: 18235d89-cb13-479d-ad71-7a57d5f669a8' \
  --header 'TIMESTAMP: 2022-10-06T15:10:00.587Z' \
  --header 'X-CM-ID: sbx'