SDKs overview
MyVaccination provides Software Development Kits (SDKs) and libraries designed to assist healthcare organizations in integrating the MyVaccination platform with their existing IT infrastructure. These SDKs enable programmatic interaction with core MyVaccination functionalities, including managing digital vaccination records, tracking vaccine inventory, and scheduling appointments within a controlled environment. The target audience for these SDKs includes developers working within NHS trusts and private healthcare providers who require robust integration capabilities to support large-scale vaccination programs and digital health record management, as detailed on the MyVaccination help page. The SDKs are tailored for secure, internal system-to-system communication, reflecting a focus on enterprise integration rather than public-facing API access, a common pattern in healthcare IT solutions.
The SDKs abstract the underlying API interactions, providing language-specific interfaces that simplify common tasks. This approach aims to reduce development time and enhance data consistency across integrated systems. Developers can utilize these tools to create custom workflows, automate data synchronization, and embed MyVaccination features directly into their proprietary applications. The design philosophy emphasizes compliance with healthcare data standards and regulations, such as GDPR, to ensure secure and private handling of patient information. For example, secure data exchange protocols are fundamental to healthcare integrations, often relying on standards like FHIR (Fast Healthcare Interoperability Resources) for structured health data exchange, as specified by organizations like HL7 International.
Official SDKs by language
MyVaccination offers official SDKs for several programming languages to facilitate integration with diverse backend systems. These SDKs are maintained by MyVaccination and are the recommended method for interacting with the platform's APIs. Each SDK provides a set of classes and methods that map to the platform's functionalities, simplifying the process of making API calls, handling responses, and managing authentication. The following table outlines the currently available official SDKs, their respective package managers, installation commands, and maturity levels as of 2026-05-29.
| Language | Package Name | Installation Command | Maturity Level |
|---|---|---|---|
| Python | myvaccination-python |
pip install myvaccination-python |
Stable (v1.2.0) |
| Java | com.myvaccination:myvaccination-java |
Maven: Add dependency to pom.xml / Gradle: Add dependency to build.gradle |
Stable (v1.1.5) |
| C# (.NET) | MyVaccination.NET |
dotnet add package MyVaccination.NET |
Stable (v1.0.8) |
| Node.js | @myvaccination/nodejs-sdk |
npm install @myvaccination/nodejs-sdk |
Stable (v1.3.1) |
Installation
Installing the MyVaccination SDKs typically involves using the standard package manager for each respective programming language. Detailed instructions and prerequisites are available in the MyVaccination developer guides. Before installation, ensure your development environment meets the minimum version requirements for the chosen language and its package manager.
Python SDK
To install the Python SDK, use pip, the Python package installer:
pip install myvaccination-python
Ensure you have a supported Python version (3.7+) installed. Virtual environments are recommended for managing dependencies.
Java SDK
For Java projects, the SDK is available via Maven Central and Gradle. For Maven, add the following to your pom.xml:
<dependency>
<groupId>com.myvaccination</groupId>
<artifactId>myvaccination-java</artifactId&n>
<version>1.1.5</version>
</dependency>
For Gradle, add to your build.gradle:
implementation 'com.myvaccination:myvaccination-java:1.1.5'
A Java Development Kit (JDK) version 8 or higher is required.
C# (.NET) SDK
The .NET SDK can be installed using the NuGet Package Manager via the .NET CLI:
dotnet add package MyVaccination.NET
This requires a .NET SDK of version 6.0 or later.
Node.js SDK
Install the Node.js SDK using npm or yarn:
npm install @myvaccination/nodejs-sdk
# or
yarn add @myvaccination/nodejs-sdk
Node.js version 14 or higher is necessary.
Quickstart example
This example demonstrates how to use the Python SDK to retrieve a list of vaccination appointments. Before running, ensure you have configured your API credentials, typically an API key and a secret, which are provided upon successful onboarding to the MyVaccination platform. These credentials are used to authenticate requests to the MyVaccination API endpoints.
from myvaccination_python import MyVaccinationClient
from datetime import date
# Initialize the client with your API key and secret
# These should ideally be loaded from environment variables or a secure configuration system
client = MyVaccinationClient(api_key="YOUR_API_KEY", api_secret="YOUR_API_SECRET")
try:
# Define the date for which to retrieve appointments
target_date = date(2026, 6, 1)
# Retrieve appointments for the specified date
# The 'get_appointments' method handles the API request and response parsing
appointments = client.get_appointments(date=target_date)
print(f"Appointments for {target_date}:")
if appointments:
for appointment in appointments:
print(f" - Patient ID: {appointment.patient_id}, Time: {appointment.time}, Vaccine: {appointment.vaccine_type}")
else:
print(" No appointments found.")
except Exception as e:
print(f"An error occurred: {e}")
This snippet initializes the MyVaccinationClient, sets a target date, and calls the get_appointments method. The response is then iterated to display relevant appointment details. Proper error handling is included to manage potential issues during API communication or data processing. For production environments, it is crucial to handle API credentials securely, often using environment variables or dedicated secret management services rather than hardcoding them directly in the source code, as recommended by security best practices for Google Cloud's secret management guidelines.
Community libraries
As MyVaccination primarily focuses on direct enterprise integration within healthcare organizations, and given its relatively specialized application, there is a limited public ecosystem of community-developed libraries compared to more general-purpose APIs. The emphasis for MyVaccination remains on official SDKs and direct vendor engagement for integration support, as noted in its developer experience documentation.
While official support is prioritized, developers within specific healthcare systems may develop internal utilities or wrappers to streamline their integration processes. These are typically proprietary and not distributed publicly. Should public community efforts emerge, they would likely be found on platforms like GitHub, often prefixed with myvaccination-, and would complement the official SDKs by offering niche functionalities, alternative language bindings, or specialized data transformations. Developers interested in contributing or seeking community tools are encouraged to monitor relevant open-source repositories and forums within the health tech sector.