Introduction

The Welly API lets doctors, clinics, pharmacies and medical companies connect their own systems to Welly, the online training and lifestyle programme they follow their patients and customers through.

Where the API stands#

The API is in early access. We are building it together with our first partners, and every endpoint is agreed with a partner before it is built. Today it has one endpoint, GET /v1/ping, which anyone can call:

$ curl https://api.welly.no/v1/ping

{
  "object": "ping",
  "pong": true
}

The API reference lists what works now, and only that. This guide and the others describe the rules every endpoint will follow, so you can plan your integration before the endpoints you need exist.

What you can build#

The first endpoints are meant for partners who follow people through Welly's programme:

• Doctors and clinics who want to enrol their patients in a programme from their own system and see how far they have come.
• Medical companies who offer Welly's programme beside their own services, under their own brand.
• Pharmacies who want to give customers starting a treatment a way into the programme, with their consent.

Tell us what you need on the contact page. What partners ask for decides which endpoints come first.

Health data#

What Welly holds about its members is health data, which the GDPR counts as sensitive personal data. Before any key reaches member data, we sign partner terms and a data processing agreement with you. The API gives members by their id, never by name or contact details, unless an endpoint exists for that and the agreement covers it.

Next steps#

1. Read Getting access to see how a partnership starts.
2. Read Requests and responses for the rules every endpoint follows.
3. Contact us with what you want to build.