Junction API

Overview of the Junction API including production and sandbox environments, regional endpoints, authentication methods, and core API capabilities.

You use Junction API to:

• manage users and demographics information in your Team with the Core API;
• manage user connections, pull ingested device data, inspect connection backfill statuses through the Devices API;
• order lab tests, manage appointments and pull the results through the Lab Testing API; and
• aggregate ingested device data with the Junction Sense 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.us.junction.com/	pk_us_*
🇪🇺 Production EU	https://api.eu.junction.com/	pk_eu_*
🇺🇸 Sandbox US	https://api.sandbox.us.junction.com/	sk_us_*
🇪🇺 Sandbox EU	https://api.sandbox.eu.junction.com/	sk_eu_*

If you are using a *.tryvital.io Base URL, they are still supported alongside *.junction.com.

Sandbox environments are functionally identical to Production environments, except that:

1. Each Team can have only up to 50 Users in Sandbox;
2. You can create Synthetic Device connections; and
3. 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:

1. the Team Config page in the Junction Dashboard; or
2. 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

curl --request GET \
  --url 'https://api.tryvital.io/v2/providers' \
  --header 'X-Vital-API-Key: <YOUR-TEAM-API-KEY>'

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 support 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.