Skip to main content

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

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (JWT)

Author

Metadata

Release files for abha 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for abha 1.0.1
File Size Uploaded Provenance Actions
abha-1.0.1.tar.gz 44.8 kB Without provenance Details for abha-1.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for abha 1.0.1
File Interpreter ABI Platform Actions
abha-1.0.1-py3-none-any.whl Python 3 none any Details for abha-1.0.1-py3-none-any.whl

Total release size: 83.4 kB

Release files / abha-1.0.1.tar.gz

Download URL abha-1.0.1.tar.gz
Size 44.8 kB
Tags Source
SHA-256 checksum
How to use checksums
963bf7dc22e3ec6beafa15cd1d3b693fadff4fe540353cf30c92019575fa8842
BLAKE2b-256 checksum
How to use checksums
1e1df731fc6e259d006ed7494d3cd898e1760705ba2d92365af3575bfd178891
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.7.1 CPython/3.12.3 Darwin/23.5.0

Release files / abha-1.0.1-py3-none-any.whl

Download URL abha-1.0.1-py3-none-any.whl
Size 38.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
092aaa9582e1421a69698c9512664bc487181dc6029c6aec9f8c06a5170e5011
BLAKE2b-256 checksum
How to use checksums
9e46244cdf699e5fb522f593f0721d74dabc354a764ce3c58fc08502271e0132
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.7.1 CPython/3.12.3 Darwin/23.5.0

Security for abha 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page