API
Junction API
You use Junction API to:
- manage users, demographics information and device connections in your Team with the Core API;
- pull ingested device data and inspect backfill progress through the Data Access API;
- order lab tests, manage appointments and pull the results through the Lab Testing API; and
- aggregate ingested device data with the Horizon AI Query API;
For managing Team configuration and Org resources programmatically, see Junction Management API.
Environments
Junction provides two Sandbox environments and two Production environments today:
Environment | Base URL | Team API Key Prefix |
---|---|---|
πΊπΈ Production US | https://api.tryvital.io/ | pk_us_* |
πͺπΊ Production EU | https://api.eu.tryvital.io/ | pk_eu_* |
πΊπΈ Sandbox US | https://api.sandbox.tryvital.io/ | sk_us_* |
πͺπΊ Sandbox EU | https://api.sandbox.eu.tryvital.io/ | sk_eu_* |
Sandbox environments are functionally identical to Production environments, except that:
- Each Team can have only up to 50 Users in Sandbox;
- You can create Synthetic Device connections connections; and
- You can simulate and transition an order through its lifecycle.
Authentication
Junction API accepts Team API Key. You can provision a Team API Key through:
- the Team Config page in the Junction Dashboard; or
- the Create Team API Key endpoint of the Junction Management API.
Your API requests should present the Team API Key under the X-Vital-API-Key
header. For example:
cURL
A Management Key used by Junction Management API does not function as Team API Key. However, you can manage Team API Keys through a Management Key.
Junction Mobile SDKs
Junction Mobile SDKs supports two authentication methods:
Scheme | Authorization | Recommended use case |
---|---|---|
Sign-In Token | User-scoped access | Production mobile apps |
Team API Keys | Full Team data access | Proof-of-concept |
Refer to the Mobile SDK Authentication documentation for more information.