Getting Started with Form3 Public API
Install the Package
The package is compatible with Python versions 3 >=3.7, <= 3.11.
Install the package from PyPi using the following pip command:
pip install vendor-zahra==1.1.1
You can also view the package at: https://pypi.python.org/pypi/vendor-zahra/1.1.1
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
http_client_instance |
HttpClient |
The Http Client passed from the sdk user for making requests |
override_http_client_configuration |
bool |
The value which determines to override properties of the passed Http Client from the sdk user |
http_call_back |
HttpCallBack |
The callback value that is invoked before and after an HTTP call is made to an endpoint |
timeout |
float |
The value to use for connection timeout. Default: 60 |
max_retries |
int |
The number of times to retry an endpoint call if it fails. Default: 0 |
backoff_factor |
float |
A backoff factor to apply between attempts after the second try. Default: 2 |
retry_statuses |
Array of int |
The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524] |
retry_methods |
Array of string |
The http methods on which retry is to be done. Default: ['GET', 'PUT'] |
basic_credentials |
BasicCredentials |
The credential object for Basic Authentication |
o_auth_2_credentials |
OAuth2Credentials |
The credential object for OAuth 2 Client Credentials Grant |
The API client can be initialized as follows:
client = Form3publicapiClient(
basic_credentials=BasicCredentials(
username='Username',
password='Password'
),
o_auth_2_credentials=OAuth2Credentials(
o_auth_client_id='OAuthClientId',
o_auth_client_secret='OAuthClientSecret'
),
environment=Environment.PRODUCTION
)
Authorization
This API uses the following authentication schemes.
List of APIs
- Scheme File API
- Transaction File API
- Metrics API
- Name Verification API
- O Auth Authorization
- Audit
- Reports
- Scheme Messages
- Subscriptions
- Oauth 2
- Accounts
- Account Identification
- Branches
- Branch Identification
- Payments
- Organisations
- Platformsecurityapi
- Roles
- ACE
- Users
- Claims
- Direct Debits
- Mandates
- Query Api
- Account Validation
Classes Documentation
1 maintainer
Metadata
1 maintainer
Release files for vendor-zahra 1.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| vendor_zahra-1.1.1.tar.gz | 234.1 kB | Without provenance | Details for vendor_zahra-1.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| vendor_zahra-1.1.1-py3-none-any.whl | Python 3 | none | any | Details for vendor_zahra-1.1.1-py3-none-any.whl |
Total release size: 1.2 MB
Release files / vendor_zahra-1.1.1.tar.gz
| Download URL | vendor_zahra-1.1.1.tar.gz |
|---|---|
| Size | 234.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0fa8dc07d960a2ce6ec13218aca8f9c52294fac7fc05b53a4c1e8cbdeb0bec77
|
|
BLAKE2b-256 checksum How to use checksums |
f6d177c4d4f742341f04932234dd44e90dfc28fc7d86a6150525d133da785859
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.13
|
Release files / vendor_zahra-1.1.1-py3-none-any.whl
| Download URL | vendor_zahra-1.1.1-py3-none-any.whl |
|---|---|
| Size | 973.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2dd009b7835cb21d0e1f46adb1e9873d3ab98625312e2d8ec84cd7c3b9eccf08
|
|
BLAKE2b-256 checksum How to use checksums |
eb419b7096265c01e79e7adee7de5648289728be3f7cb088da70d9f68649f53a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.13
|
Security for vendor-zahra 1.1.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.
