abha

Abdm SDK for abha

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

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.6.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 abha

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 abha

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import abha
from abha.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = abha.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with abha.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = abha.DefaultApi(api_client)
    auth_aadhar_init_request = abha.AuthAadharInitRequest() # AuthAadharInitRequest | 

    try:
        # auth-aadhar-init
        api_response = api_instance.auth_aadhar_init(auth_aadhar_init_request)
        print("The response of DefaultApi->auth_aadhar_init:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->auth_aadhar_init: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://healthidsbx.abdm.gov.in/api/v1

Class	Method	HTTP request	Description
DefaultApi	auth_aadhar_init	POST /auth/init	auth-aadhar-init
DefaultApi	confirm_with_aadhaar_otp	POST /auth/confirmWithAadhaarOtp	aadhar-otp-confirm
DefaultApi	create_health_id_with_pre_verified	POST /registration/aadhaar/createHealthIdWithPreVerified	Health ID creation
DefaultApi	generate_card_using_get	GET /account/getCard	Generate ABHA card in PDF format
DefaultApi	generate_mobile_otp	POST /registration/aadhaar/generateMobileOTP	Generate Mobile OTP
DefaultApi	generate_otp	POST /registration/aadhaar/generateOtp	Generate OTP
DefaultApi	generate_png_card_using_get	GET /account/getPngCard	Generate ABHA card PNG
DefaultApi	generate_svg_card_using_get	GET /account/getSvgCard	Generate ABHA card SVG
DefaultApi	get_account_information_using_get	GET /account/profile	Get account information.
DefaultApi	get_qr_code_using_get	GET /account/qrCode	Get Quick Response code in PNG format for this account.
DefaultApi	resend_auth_otp	POST /auth/resendAuthOTP	resend-auth-aadhar-init
DefaultApi	verify_mobile_otp	POST /registration/aadhaar/verifyMobileOTP	Verify Mobile OTP
DefaultApi	verify_otp	POST /registration/aadhaar/verifyOTP	Verify OTP

Documentation For Models

• AuthAadharInitRequest
• CreateHealthIdWithPreVerified200Response
• CreateHealthIdWithPreVerifiedRequest
• GenerateMobileOtpRequest
• GenerateOtp200Response
• GenerateOtpRequest
• GeneratePngCardUsingGET200Response
• GetAccountInformationUsingGET200Response
• ResendAuthOTPRequest
• VerifyOtpRequest

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Author