General Information

REST API

The SADV software is accessible through a REST API. A REST API is a web interface that exposes resources and operations over HTTP. Concretely, your software sends HTTP requests to API endpoints, with JSON data, and receives JSON responses in return.

Technical Support

SADV technical support is intended for teams integrating the API into a client application.

To open a request, send a message to developers@syadem.com.

Technical support covers API access, authentication, and integration error analysis.

API Update Policy

The SADV API follows semantic versioning (SemVer), based on three levels: major, minor, and patch. The version format is MAJOR.MINOR.PATCH:

  • MAJOR: non-backward-compatible change.
  • MINOR: addition of features compatible with existing integrations.
  • PATCH: fix without changing the expected integration behavior.

In practice, a minor version adds compatible capabilities, and a patch version fixes behavior without modifying the contract expected by your integration.

Because SADV is delivered as SaaS, updates are deployed regularly to improve features and fix anomalies.

Syadem is committed to maintaining backward compatibility for the API: existing integrations are not broken by minor and patch updates.

If a non-backward-compatible change is needed, you will be informed in advance and supported through the transition. The new version will be made available in the integration environment during a notice period communicated ahead of time, so that you can test and adjust your integration before production deployment.

Integrating the SADV API

You can integrate the SADV API in two ways:

  1. By using a sadv-client client library, which handles HTTP request construction and JSON response interpretation.
  2. By calling the API directly over HTTP, according to the OpenAPI specification.

Whichever mode you choose, the main API endpoint is /diagnostic_for_patient, which receives patient data and returns vaccination recommendations.

Nomenclatures Used by the API

The API relies on two complementary nomenclatures to structure input data:

  • NUVA: structures the vaccination history, notably through the identifiers used in prevention_acts.
  • VaccinationProfile: structures the health profile through the conditions field, with explicit data types (boolean, date, integer, etc.).

For integration:

Next Step

Configure the SADV instance to use (territory, environment, base URL) before your first API call.