Important
This repository has been archived and will not receive further updates.
The maintained SDK lives at junction-api/junction-python
and is published to PyPI as junction-api-sdk.
See the migration guide for upgrade instructions.
API reference documentation is available here.
Add this dependency to your project's build file:
pip install vital
# or
poetry add vitalfromvital.clientimportVitalvital_client=Vital(
api_key="YOUR_API_KEY",
)
lab_test=vital_client.lab_tests.get('order-id')
print(lab_test)Please note: To ensure future compatibility, we ask that you avoid exhaustive matching on enum values such as an order’s status. We may introduce new statuses (and other enum values) over time, and code that assumes all current values are exhaustive could break or fail to compile with SDK upgrades.
To stay compatible and benefit from future enhancements, treat unknown values gracefully—for example, by using default cases or limiting checks to only the values your integration depends on.
The SDK also exports an async client.
fromvital.clientimportAsyncVitalimportasynciovital_client=AsyncVital(
api_key="YOUR_API_KEY",
)
asyncdefget_lab_test() ->None:
lab_test=vital_client.lab_tests.get('order-id')
print(lab_test)
asyncio.run(get_lab_test())All exceptions thrown by the SDK will sublcass ApiError.
fromvital.coreimportApiErrorfromvitalimportBadRequestErrortry:
vital_client.lab_tests.get('order-id')
exceptBadRequestErrorase:
# handle bad request errorexceptAPIErrorase:
# handle any api related errorWhen you sign up to Vital you get access to two environments, Sandbox and Production.
| Environment URLs | |
|---|---|
production | api.tryvital.io |
production-eu | api.eu.tryvital.io |
sandbox | api.sandbox.tryvital.io |
sandbox-eu | api.sandbox.eu.tryvital.io |
By default, the SDK uses the production environment. See the snippet below
for an example on how ot change the environment.
fromvital.clientimportVitalfromvital.environmentimportVitalEnvironmentvital_client=Vital(
api_key="YOUR_API_KEY",
environment=VitalEnvironment.Sandbox
)By default, the client is configured to have a timeout of 60 seconds. You can customize this value at client instantiation.
fromvital.clientimportVitalfromvital.environmentimportVitalEnvironmentvital_client=Vital(
api_key="YOUR_API_KEY",
environment=VitalEnvironment.Sandbox,
timeout=15
)While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!