Link Demo provider

Create or submit link connect demo via the Junction API. Requires authentication with your team API key.

POST /v2/link/connect/demo

cURL

curl --request POST \
     --url {{BASE_URL}}/v2/link/connect/demo \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-vital-link-token: <VITAL-LINK-TOKEN>' \
     --data '
{
    "user_id": "1875c190-0cd6-46c1-8670-5b56a7794b78",
    "provider": "fitbit"
}
'

import { JunctionClient, JunctionEnvironment, DemoProviders } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.link.connectDemoProvider({
    userId: "<user_id>",
    provider: DemoProviders.AppleHealthKit,
});

from junction import DemoProviders, Junction
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.link.connect_demo_provider(
    user_id="<user_id>",
    provider=DemoProviders.APPLE_HEALTH_KIT,
)

import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.link.requests.DemoConnectionCreationPayload;
import com.junction.api.types.DemoProviders;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.link().connectDemoProvider(
    DemoConnectionCreationPayload.builder()
        .userId("<user_id>")
        .provider(DemoProviders.APPLE_HEALTH_KIT)
        .build()
);

import (
    "context"

    junction "github.com/junction-api/junction-go"
    "github.com/junction-api/junction-go/client"
    "github.com/junction-api/junction-go/option"
)

c := client.NewClient(
    option.WithApiKey("YOUR_API_KEY"),
    option.WithBaseURL(junction.Environments.Sandbox),
)

response, err := c.Link.ConnectDemoProvider(context.TODO(), &junction.DemoConnectionCreationPayload{
    UserId:   "<user_id>",
    Provider: junction.DemoProvidersAppleHealthKit,
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

200

{
  "detail": "Connected user 37c9c3fa-49e8-4d60-8cc8-328cba420f30 to provider fitbit",
  "success": true
}

{
  "detail": "<unknown>"
}

cURL

curl --request POST \
     --url {{BASE_URL}}/v2/link/connect/demo \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-vital-link-token: <VITAL-LINK-TOKEN>' \
     --data '
{
    "user_id": "1875c190-0cd6-46c1-8670-5b56a7794b78",
    "provider": "fitbit"
}
'

import { JunctionClient, JunctionEnvironment, DemoProviders } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.link.connectDemoProvider({
    userId: "<user_id>",
    provider: DemoProviders.AppleHealthKit,
});

from junction import DemoProviders, Junction
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.link.connect_demo_provider(
    user_id="<user_id>",
    provider=DemoProviders.APPLE_HEALTH_KIT,
)

import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.link.requests.DemoConnectionCreationPayload;
import com.junction.api.types.DemoProviders;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.link().connectDemoProvider(
    DemoConnectionCreationPayload.builder()
        .userId("<user_id>")
        .provider(DemoProviders.APPLE_HEALTH_KIT)
        .build()
);

import (
    "context"

    junction "github.com/junction-api/junction-go"
    "github.com/junction-api/junction-go/client"
    "github.com/junction-api/junction-go/option"
)

c := client.NewClient(
    option.WithApiKey("YOUR_API_KEY"),
    option.WithBaseURL(junction.Environments.Sandbox),
)

response, err := c.Link.ConnectDemoProvider(context.TODO(), &junction.DemoConnectionCreationPayload{
    UserId:   "<user_id>",
    Provider: junction.DemoProvidersAppleHealthKit,
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

Authorizations

x-vital-api-key · string · header · required

Vital Team API Key

Body

application/json

user_id · string<uuid4> · required

Vital user ID

provider · enum<string> · required

Demo provider. For more information, please check out our docs (https://docs.tryvital.io/wearables/providers/test_data) ℹ️ This enum is non-exhaustive.

Available options: apple_health_kit, fitbit, freestyle_libre, oura

Response

200

application/json

Successful Response

success · boolean · required

detail · string · required