Catalog PyPI
PACKAGE EXPLORERView in registry

abha

PyPI

Abdm Abha

abdmabhaopenapiopenapi-generator
Versions collected1
Direct dependencies5From release 1.0.1
Last observed20 Oct, 17:21 UTC

README

Version 1.0.1 documentation

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

ClassMethodHTTP requestDescription
DefaultApiauth_aadhar_initPOST /auth/initauth-aadhar-init
DefaultApiconfirm_with_aadhaar_otpPOST /auth/confirmWithAadhaarOtpaadhar-otp-confirm
DefaultApicreate_health_id_with_pre_verifiedPOST /registration/aadhaar/createHealthIdWithPreVerifiedHealth ID creation
DefaultApigenerate_card_using_getGET /account/getCardGenerate ABHA card in PDF format
DefaultApigenerate_mobile_otpPOST /registration/aadhaar/generateMobileOTPGenerate Mobile OTP
DefaultApigenerate_otpPOST /registration/aadhaar/generateOtpGenerate OTP
DefaultApigenerate_png_card_using_getGET /account/getPngCardGenerate ABHA card PNG
DefaultApigenerate_svg_card_using_getGET /account/getSvgCardGenerate ABHA card SVG
DefaultApiget_account_information_using_getGET /account/profileGet account information.
DefaultApiget_qr_code_using_getGET /account/qrCodeGet Quick Response code in PNG format for this account.
DefaultApiresend_auth_otpPOST /auth/resendAuthOTPresend-auth-aadhar-init
DefaultApiverify_mobile_otpPOST /registration/aadhaar/verifyMobileOTPVerify Mobile OTP
DefaultApiverify_otpPOST /registration/aadhaar/verifyOTPVerify OTP

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (JWT)

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.121 Jun 20245

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:21 UTC

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

Record identity

package:e3db7635d7bf45c872eda1fb2b6d920d34997514cd4fd23b4c0119c1ac2f24ce