# abha
Abdm SDK for abha
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) 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:
```sh
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:
```python
import abha
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import abha
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
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**](docs/DefaultApi.md#auth_aadhar_init) | **POST** /auth/init | auth-aadhar-init
*DefaultApi* | [**confirm_with_aadhaar_otp**](docs/DefaultApi.md#confirm_with_aadhaar_otp) | **POST** /auth/confirmWithAadhaarOtp | aadhar-otp-confirm
*DefaultApi* | [**create_health_id_with_pre_verified**](docs/DefaultApi.md#create_health_id_with_pre_verified) | **POST** /registration/aadhaar/createHealthIdWithPreVerified | Health ID creation
*DefaultApi* | [**generate_card_using_get**](docs/DefaultApi.md#generate_card_using_get) | **GET** /account/getCard | Generate ABHA card in PDF format
*DefaultApi* | [**generate_mobile_otp**](docs/DefaultApi.md#generate_mobile_otp) | **POST** /registration/aadhaar/generateMobileOTP | Generate Mobile OTP
*DefaultApi* | [**generate_otp**](docs/DefaultApi.md#generate_otp) | **POST** /registration/aadhaar/generateOtp | Generate OTP
*DefaultApi* | [**generate_png_card_using_get**](docs/DefaultApi.md#generate_png_card_using_get) | **GET** /account/getPngCard | Generate ABHA card PNG
*DefaultApi* | [**generate_svg_card_using_get**](docs/DefaultApi.md#generate_svg_card_using_get) | **GET** /account/getSvgCard | Generate ABHA card SVG
*DefaultApi* | [**get_account_information_using_get**](docs/DefaultApi.md#get_account_information_using_get) | **GET** /account/profile | Get account information.
*DefaultApi* | [**get_qr_code_using_get**](docs/DefaultApi.md#get_qr_code_using_get) | **GET** /account/qrCode | Get Quick Response code in PNG format for this account.
*DefaultApi* | [**resend_auth_otp**](docs/DefaultApi.md#resend_auth_otp) | **POST** /auth/resendAuthOTP | resend-auth-aadhar-init
*DefaultApi* | [**verify_mobile_otp**](docs/DefaultApi.md#verify_mobile_otp) | **POST** /registration/aadhaar/verifyMobileOTP | Verify Mobile OTP
*DefaultApi* | [**verify_otp**](docs/DefaultApi.md#verify_otp) | **POST** /registration/aadhaar/verifyOTP | Verify OTP
## Documentation For Models
- [AuthAadharInitRequest](docs/AuthAadharInitRequest.md)
- [CreateHealthIdWithPreVerified200Response](docs/CreateHealthIdWithPreVerified200Response.md)
- [CreateHealthIdWithPreVerifiedRequest](docs/CreateHealthIdWithPreVerifiedRequest.md)
- [GenerateMobileOtpRequest](docs/GenerateMobileOtpRequest.md)
- [GenerateOtp200Response](docs/GenerateOtp200Response.md)
- [GenerateOtpRequest](docs/GenerateOtpRequest.md)
- [GeneratePngCardUsingGET200Response](docs/GeneratePngCardUsingGET200Response.md)
- [GetAccountInformationUsingGET200Response](docs/GetAccountInformationUsingGET200Response.md)
- [ResendAuthOTPRequest](docs/ResendAuthOTPRequest.md)
- [VerifyOtpRequest](docs/VerifyOtpRequest.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth
- **Type**: Bearer authentication (JWT)
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "abha",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Abdm Abha",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/1e/1d/f731fc6e259d006ed7494d3cd898e1760705ba2d92365af3575bfd178891/abha-1.0.1.tar.gz",
"platform": null,
"description": "# abha\nAbdm SDK for abha\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 1.0.0\n- Generator version: 7.6.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport abha\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport abha\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport abha\nfrom abha.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://healthidsbx.abdm.gov.in/api/v1\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = abha.Configuration(\n host = \"https://healthidsbx.abdm.gov.in/api/v1\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization (JWT): bearerAuth\nconfiguration = abha.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith abha.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = abha.DefaultApi(api_client)\n auth_aadhar_init_request = abha.AuthAadharInitRequest() # AuthAadharInitRequest | \n\n try:\n # auth-aadhar-init\n api_response = api_instance.auth_aadhar_init(auth_aadhar_init_request)\n print(\"The response of DefaultApi->auth_aadhar_init:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DefaultApi->auth_aadhar_init: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://healthidsbx.abdm.gov.in/api/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**auth_aadhar_init**](docs/DefaultApi.md#auth_aadhar_init) | **POST** /auth/init | auth-aadhar-init\n*DefaultApi* | [**confirm_with_aadhaar_otp**](docs/DefaultApi.md#confirm_with_aadhaar_otp) | **POST** /auth/confirmWithAadhaarOtp | aadhar-otp-confirm\n*DefaultApi* | [**create_health_id_with_pre_verified**](docs/DefaultApi.md#create_health_id_with_pre_verified) | **POST** /registration/aadhaar/createHealthIdWithPreVerified | Health ID creation\n*DefaultApi* | [**generate_card_using_get**](docs/DefaultApi.md#generate_card_using_get) | **GET** /account/getCard | Generate ABHA card in PDF format\n*DefaultApi* | [**generate_mobile_otp**](docs/DefaultApi.md#generate_mobile_otp) | **POST** /registration/aadhaar/generateMobileOTP | Generate Mobile OTP\n*DefaultApi* | [**generate_otp**](docs/DefaultApi.md#generate_otp) | **POST** /registration/aadhaar/generateOtp | Generate OTP\n*DefaultApi* | [**generate_png_card_using_get**](docs/DefaultApi.md#generate_png_card_using_get) | **GET** /account/getPngCard | Generate ABHA card PNG\n*DefaultApi* | [**generate_svg_card_using_get**](docs/DefaultApi.md#generate_svg_card_using_get) | **GET** /account/getSvgCard | Generate ABHA card SVG\n*DefaultApi* | [**get_account_information_using_get**](docs/DefaultApi.md#get_account_information_using_get) | **GET** /account/profile | Get account information.\n*DefaultApi* | [**get_qr_code_using_get**](docs/DefaultApi.md#get_qr_code_using_get) | **GET** /account/qrCode | Get Quick Response code in PNG format for this account.\n*DefaultApi* | [**resend_auth_otp**](docs/DefaultApi.md#resend_auth_otp) | **POST** /auth/resendAuthOTP | resend-auth-aadhar-init\n*DefaultApi* | [**verify_mobile_otp**](docs/DefaultApi.md#verify_mobile_otp) | **POST** /registration/aadhaar/verifyMobileOTP | Verify Mobile OTP\n*DefaultApi* | [**verify_otp**](docs/DefaultApi.md#verify_otp) | **POST** /registration/aadhaar/verifyOTP | Verify OTP\n\n\n## Documentation For Models\n\n - [AuthAadharInitRequest](docs/AuthAadharInitRequest.md)\n - [CreateHealthIdWithPreVerified200Response](docs/CreateHealthIdWithPreVerified200Response.md)\n - [CreateHealthIdWithPreVerifiedRequest](docs/CreateHealthIdWithPreVerifiedRequest.md)\n - [GenerateMobileOtpRequest](docs/GenerateMobileOtpRequest.md)\n - [GenerateOtp200Response](docs/GenerateOtp200Response.md)\n - [GenerateOtpRequest](docs/GenerateOtpRequest.md)\n - [GeneratePngCardUsingGET200Response](docs/GeneratePngCardUsingGET200Response.md)\n - [GetAccountInformationUsingGET200Response](docs/GetAccountInformationUsingGET200Response.md)\n - [ResendAuthOTPRequest](docs/ResendAuthOTPRequest.md)\n - [VerifyOtpRequest](docs/VerifyOtpRequest.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"bearerAuth\"></a>\n### bearerAuth\n\n- **Type**: Bearer authentication (JWT)\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "Abdm Abha",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" abdm abha"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e46244cdf699e5fb522f593f0721d74dabc354a764ce3c58fc08502271e0132",
"md5": "6ae17482a91c64284acdd35868b59841",
"sha256": "092aaa9582e1421a69698c9512664bc487181dc6029c6aec9f8c06a5170e5011"
},
"downloads": -1,
"filename": "abha-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6ae17482a91c64284acdd35868b59841",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 38602,
"upload_time": "2024-06-21T07:22:04",
"upload_time_iso_8601": "2024-06-21T07:22:04.079887Z",
"url": "https://files.pythonhosted.org/packages/9e/46/244cdf699e5fb522f593f0721d74dabc354a764ce3c58fc08502271e0132/abha-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e1df731fc6e259d006ed7494d3cd898e1760705ba2d92365af3575bfd178891",
"md5": "5442ab19e52d911442067612f7aa12cb",
"sha256": "963bf7dc22e3ec6beafa15cd1d3b693fadff4fe540353cf30c92019575fa8842"
},
"downloads": -1,
"filename": "abha-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "5442ab19e52d911442067612f7aa12cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 44782,
"upload_time": "2024-06-21T07:22:05",
"upload_time_iso_8601": "2024-06-21T07:22:05.669083Z",
"url": "https://files.pythonhosted.org/packages/1e/1d/f731fc6e259d006ed7494d3cd898e1760705ba2d92365af3575bfd178891/abha-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-21 07:22:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "abha"
}
JSON
