PkgFoundry
Catalog PyPI
PACKAGE EXPLORERView in registry

abdm_gateway

PyPI

Gateway

gatewayopenapiopenapi-generator
Versions collected1
Direct dependencies4From release 1.0.0
Last observed20 Oct, 17:17 UTC

README

Version 1.0.0 documentation

abdm-gateway

Gateway is the hub that routes/orchestrates the interaction between consent managers and API bridges. There are 5 categories of APIs; discovery, link, consent flow, data flow and monitoring. To reflect the consumers of APIs, the above apis are also categorized under cm facing, hiu facing and hip facing

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.5
  • Package version: 1.0.0
  • Generator version: 7.5.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import abdm_gateway

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import abdm_gateway

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


import abdm_gateway
from abdm_gateway.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dev.abdm.gov.in/gateway
# See configuration.py for a list of all supported configuration parameters.
configuration = abdm_gateway.Configuration(
    host = "https://dev.abdm.gov.in/gateway"
)



# Enter a context with an instance of the API client
with abdm_gateway.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = abdm_gateway.CmFacingApi(api_client)
    authorization = 'authorization_example' # str | Access token which was issued after successful login with gateway auth server.
    x_hip_id = 'x_hip_id_example' # str | Identifier of the health information provider to which the request was intended.
    patient_discovery_request = abdm_gateway.PatientDiscoveryRequest() # PatientDiscoveryRequest | 

    try:
        # Discover patient's accounts
        api_instance.v05_care_contexts_discover_post(authorization, x_hip_id, patient_discovery_request)
    except ApiException as e:
        print("Exception when calling CmFacingApi->v05_care_contexts_discover_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://dev.abdm.gov.in/gateway

ClassMethodHTTP requestDescription
CmFacingApiv05_care_contexts_discover_postPOST /v0.5/care-contexts/discoverDiscover patient's accounts
CmFacingApiv05_care_contexts_on_discover_postPOST /v0.5/care-contexts/on-discoverResponse to patient's account discovery request
CmFacingApiv05_consent_requests_on_init_postPOST /v0.5/consent-requests/on-initResponse to consent request
CmFacingApiv05_consent_requests_on_status_postPOST /v0.5/consent-requests/on-statusResult of consent request status
CmFacingApiv05_consents_hip_notify_postPOST /v0.5/consents/hip/notifyConsent notification
CmFacingApiv05_consents_hiu_notify_postPOST /v0.5/consents/hiu/notifyConsent notification
CmFacingApiv05_consents_on_fetch_postPOST /v0.5/consents/on-fetchResult of fetch request for a consent artefact
CmFacingApiv05_health_information_cm_on_request_postPOST /v0.5/health-information/cm/on-requestHealth information data request
CmFacingApiv05_health_information_hip_request_postPOST /v0.5/health-information/hip/requestHealth information data request
CmFacingApiv05_links_context_on_notify_postPOST /v0.5/links/context/on-notifyAcknowledgement sent by Consent Manager to HIP for data notification.
CmFacingApiv05_links_link_confirm_postPOST /v0.5/links/link/confirmToken submission by Consent Manager for link confirmation
CmFacingApiv05_links_link_init_postPOST /v0.5/links/link/initLink patient's care contexts
CmFacingApiv05_links_link_on_add_contexts_postPOST /v0.5/links/link/on-add-contextscallback API for HIP initiated patient linking /link/add-context
CmFacingApiv05_patients_on_find_postPOST /v0.5/patients/on-findIdentification result for a consent-manager user-id
CmFacingApiv05_patients_profile_share_postPOST /v0.5/patients/profile/shareShare patient profile details
CmFacingApiv05_patients_sms_on_notify_postPOST /v0.5/patients/sms/on-notifyAcknowledgment response for SMS notification sent to patient by HIP
CmFacingApiv05_patients_status_notify_postPOST /v0.5/patients/status/notifyNotification sent by Consent MAnager
CmFacingApiv05_subscription_requests_cm_on_init_postPOST /v0.5/subscription-requests/cm/on-initcallback API for the /subscription-requests/cm/init to notify a HIU on acceptance/acknowledgement of the request for subscription.
CmFacingApiv05_subscription_requests_hiu_notify_postPOST /v0.5/subscription-requests/hiu/notifyNotification for subscription grant/deny/revoke
CmFacingApiv05_subscriptions_hiu_notify_postPOST /v0.5/subscriptions/hiu/notifyNotification to HIU on basis of a granted subscription
CmFacingApiv05_users_auth_notify_postPOST /v0.5/users/auth/notifynotification API in case of DIRECT mode of authentication by the CM
CmFacingApiv05_users_auth_on_confirm_postPOST /v0.5/users/auth/on-confirmcallback API for /auth/confirm (in case of MEDIATED auth) to confirm user authentication or not
CmFacingApiv05_users_auth_on_fetch_modes_postPOST /v0.5/users/auth/on-fetch-modesIdentification result for a consent-manager user-id
CmFacingApiv05_users_auth_on_init_postPOST /v0.5/users/auth/on-initResponse to user authentication initialization from HIP
ConsentFlowApiv05_consent_requests_init_postPOST /v0.5/consent-requests/initCreate consent request
ConsentFlowApiv05_consent_requests_on_init_postPOST /v0.5/consent-requests/on-initResponse to consent request
ConsentFlowApiv05_consent_requests_on_status_postPOST /v0.5/consent-requests/on-statusResult of consent request status
ConsentFlowApiv05_consent_requests_status_postPOST /v0.5/consent-requests/statusGet consent request status
ConsentFlowApiv05_consents_fetch_postPOST /v0.5/consents/fetchGet consent artefact
ConsentFlowApiv05_consents_hip_notify_postPOST /v0.5/consents/hip/notifyConsent notification
ConsentFlowApiv05_consents_hip_on_notify_postPOST /v0.5/consents/hip/on-notifyConsent notification
ConsentFlowApiv05_consents_hiu_notify_postPOST /v0.5/consents/hiu/notifyConsent notification
ConsentFlowApiv05_consents_hiu_on_notify_postPOST /v0.5/consents/hiu/on-notifyConsent notification
ConsentFlowApiv05_consents_on_fetch_postPOST /v0.5/consents/on-fetchResult of fetch request for a consent artefact
DataFlowApiv05_health_information_cm_on_request_postPOST /v0.5/health-information/cm/on-requestHealth information data request
DataFlowApiv05_health_information_cm_request_postPOST /v0.5/health-information/cm/requestHealth information data request
DataFlowApiv05_health_information_hip_on_request_postPOST /v0.5/health-information/hip/on-requestHealth information data request
DataFlowApiv05_health_information_hip_request_postPOST /v0.5/health-information/hip/requestHealth information data request
DataFlowApiv05_health_information_notify_postPOST /v0.5/health-information/notifyNotifications corresponding to events during data flow
DiscoveryApiv05_care_contexts_discover_postPOST /v0.5/care-contexts/discoverDiscover patient's accounts
DiscoveryApiv05_care_contexts_on_discover_postPOST /v0.5/care-contexts/on-discoverResponse to patient's account discovery request
HipFacingApiv05_consents_hip_on_notify_postPOST /v0.5/consents/hip/on-notifyConsent notification
HipFacingApiv05_health_information_hip_on_request_postPOST /v0.5/health-information/hip/on-requestHealth information data request
HipFacingApiv05_health_information_notify_postPOST /v0.5/health-information/notifyNotifications corresponding to events during data flow
HipFacingApiv05_links_context_notify_postPOST /v0.5/links/context/notifyThis API is meant to be called by HIPs when there is new health data generated for a patient, against a care context that is already linked to patient's ABDM account.
HipFacingApiv05_links_link_add_contexts_postPOST /v0.5/links/link/add-contextsAPI for HIP initiated care-context linking for patient
HipFacingApiv05_links_link_on_confirm_postPOST /v0.5/links/link/on-confirmToken authenticated by HIP, indicating completion of linkage of care-contexts
HipFacingApiv05_links_link_on_init_postPOST /v0.5/links/link/on-initResponse to patient's care context link request
HipFacingApiv05_patients_sms_notify_postPOST /v0.5/patients/sms/notifyAPI for HIP to send SMS notifications to patients
HipFacingApiv05_patients_status_on_notify_postPOST /v0.5/patients/status/on-notifyAcknowledgment by HIP/HIU
HipFacingApiv05_users_auth_confirm_postPOST /v0.5/users/auth/confirmConfirmation request sending token, otp or other authentication details from HIP/HIU for confirmation
HipFacingApiv05_users_auth_fetch_modes_postPOST /v0.5/users/auth/fetch-modesGet a patient's authentication modes relevant to specified purpose
HipFacingApiv05_users_auth_init_postPOST /v0.5/users/auth/initInitialize authentication from HIP
HipFacingApiv05_users_auth_on_notify_postPOST /v0.5/users/auth/on-notifycallback API by HIU/HIPs as acknowledgement of auth notification
HiuFacingApiv05_consent_requests_init_postPOST /v0.5/consent-requests/initCreate consent request
HiuFacingApiv05_consent_requests_status_postPOST /v0.5/consent-requests/statusGet consent request status
HiuFacingApiv05_consents_fetch_postPOST /v0.5/consents/fetchGet consent artefact
HiuFacingApiv05_consents_hiu_on_notify_postPOST /v0.5/consents/hiu/on-notifyConsent notification
HiuFacingApiv05_health_information_cm_request_postPOST /v0.5/health-information/cm/requestHealth information data request
HiuFacingApiv05_health_information_notify_postPOST /v0.5/health-information/notifyNotifications corresponding to events during data flow
HiuFacingApiv05_patients_find_postPOST /v0.5/patients/findIdentify a patient by her consent-manager user-id
HiuFacingApiv05_patients_status_on_notify_postPOST /v0.5/patients/status/on-notifyAcknowledgment by HIP/HIU
HiuFacingApiv05_subscription_requests_cm_init_postPOST /v0.5/subscription-requests/cm/initRequest for subscription
HiuFacingApiv05_subscription_requests_hiu_on_notify_postPOST /v0.5/subscription-requests/hiu/on-notifyCallback API for /subscription-requests/hiu/notify to acknowledge receipt of notification.
HiuFacingApiv05_subscriptions_hiu_on_notify_postPOST /v0.5/subscriptions/hiu/on-notifyCallback API for /subscriptions/hiu/notify to acknowledge receipt of notification.
HiuFacingApiv05_users_auth_confirm_postPOST /v0.5/users/auth/confirmConfirmation request sending token, otp or other authentication details from HIP/HIU for confirmation
HiuFacingApiv05_users_auth_fetch_modes_postPOST /v0.5/users/auth/fetch-modesGet a patient's authentication modes relevant to specified purpose
HiuFacingApiv05_users_auth_init_postPOST /v0.5/users/auth/initInitialize authentication from HIP
HiuFacingApiv05_users_auth_on_notify_postPOST /v0.5/users/auth/on-notifycallback API by HIU/HIPs as acknowledgement of auth notification
IdentificationApiv05_patients_find_postPOST /v0.5/patients/findIdentify a patient by her consent-manager user-id
IdentificationApiv05_patients_on_find_postPOST /v0.5/patients/on-findIdentification result for a consent-manager user-id
LinkApiv05_links_context_notify_postPOST /v0.5/links/context/notifyThis API is meant to be called by HIPs when there is new health data generated for a patient, against a care context that is already linked to patient's ABDM account.
LinkApiv05_links_context_on_notify_postPOST /v0.5/links/context/on-notifyAcknowledgement sent by Consent Manager to HIP for data notification.
LinkApiv05_links_link_add_contexts_postPOST /v0.5/links/link/add-contextsAPI for HIP initiated care-context linking for patient
LinkApiv05_links_link_confirm_postPOST /v0.5/links/link/confirmToken submission by Consent Manager for link confirmation
LinkApiv05_links_link_init_postPOST /v0.5/links/link/initLink patient's care contexts
LinkApiv05_links_link_on_add_contexts_postPOST /v0.5/links/link/on-add-contextscallback API for HIP initiated patient linking /link/add-context
LinkApiv05_links_link_on_confirm_postPOST /v0.5/links/link/on-confirmToken authenticated by HIP, indicating completion of linkage of care-contexts
LinkApiv05_links_link_on_init_postPOST /v0.5/links/link/on-initResponse to patient's care context link request
MonitoringApiv05_heartbeat_getGET /v0.5/heartbeatInforms about server status
PatientNotificationApiv05_patients_sms_notify_postPOST /v0.5/patients/sms/notifyAPI for HIP to send SMS notifications to patients
PatientNotificationApiv05_patients_sms_on_notify_postPOST /v0.5/patients/sms/on-notifyAcknowledgment response for SMS notification sent to patient by HIP
PatientNotificationApiv05_patients_status_notify_postPOST /v0.5/patients/status/notifyNotification sent by Consent MAnager
PatientNotificationApiv05_patients_status_on_notify_postPOST /v0.5/patients/status/on-notifyAcknowledgment by HIP/HIU
ProfileApiv05_patients_profile_on_share_postPOST /v0.5/patients/profile/on-shareResponse to patient's share profile request
ProfileApiv05_patients_profile_share_postPOST /v0.5/patients/profile/shareShare patient profile details
ProfileApiv10_patients_profile_on_share_postPOST /v1.0/patients/profile/on-shareResponse to patient's share profile request
ProfileApiv10_patients_profile_share_postPOST /v1.0/patients/profile/shareShare patient profile details
ServicesApiv05_hi_services_service_id_getGET /v0.5/hi-services/{service-id}Get bridge service details/profile by the serviceId provided.
SessionsApiv05_certs_getGET /v0.5/certsGet certs for JWT verification
SessionsApiv05_sessions_postPOST /v0.5/sessionsGet access token
SessionsApiv05_well_known_openid_configuration_getGET /v0.5/.well-known/openid-configurationGet openid configuration
SubscriptionsApiv05_subscription_requests_cm_init_postPOST /v0.5/subscription-requests/cm/initRequest for subscription
SubscriptionsApiv05_subscription_requests_cm_on_init_postPOST /v0.5/subscription-requests/cm/on-initcallback API for the /subscription-requests/cm/init to notify a HIU on acceptance/acknowledgement of the request for subscription.
SubscriptionsApiv05_subscription_requests_hiu_notify_postPOST /v0.5/subscription-requests/hiu/notifyNotification for subscription grant/deny/revoke
SubscriptionsApiv05_subscription_requests_hiu_on_notify_postPOST /v0.5/subscription-requests/hiu/on-notifyCallback API for /subscription-requests/hiu/notify to acknowledge receipt of notification.
SubscriptionsApiv05_subscriptions_hiu_notify_postPOST /v0.5/subscriptions/hiu/notifyNotification to HIU on basis of a granted subscription
SubscriptionsApiv05_subscriptions_hiu_on_notify_postPOST /v0.5/subscriptions/hiu/on-notifyCallback API for /subscriptions/hiu/notify to acknowledge receipt of notification.
UserAuthApiv05_users_auth_confirm_postPOST /v0.5/users/auth/confirmConfirmation request sending token, otp or other authentication details from HIP/HIU for confirmation
UserAuthApiv05_users_auth_fetch_modes_postPOST /v0.5/users/auth/fetch-modesGet a patient's authentication modes relevant to specified purpose
UserAuthApiv05_users_auth_init_postPOST /v0.5/users/auth/initInitialize authentication from HIP
UserAuthApiv05_users_auth_notify_postPOST /v0.5/users/auth/notifynotification API in case of DIRECT mode of authentication by the CM
UserAuthApiv05_users_auth_on_confirm_postPOST /v0.5/users/auth/on-confirmcallback API for /auth/confirm (in case of MEDIATED auth) to confirm user authentication or not
UserAuthApiv05_users_auth_on_fetch_modes_postPOST /v0.5/users/auth/on-fetch-modesIdentification result for a consent-manager user-id
UserAuthApiv05_users_auth_on_init_postPOST /v0.5/users/auth/on-initResponse to user authentication initialization from HIP
UserAuthApiv05_users_auth_on_notify_postPOST /v0.5/users/auth/on-notifycallback API by HIU/HIPs as acknowledgement of auth notification

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 1

Collected releases
VersionPublishedDirect dependenciesOpen version
1.0.020 May 20244
Sorted by available source dates · UTC

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Repository

PENDING
git_user_id/git_repo_id

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 17:17 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:04668b73563743d9b3df738978a93c3bae7e95e855ea8fa0691023006b44daf5