Management API

Intro

This is the API documentation for the IntelliProve management API, which allows you to perform management operations such as requesting reminaing quota.

Prerequisites

If you are new to this developer portal, we recommend first reading the Plug-in: overview, a five minute read which will get you acquainted with how our plug-in works and how it can be integrated into your platform. To integrate the plug-in into your platform, follow our Plug-in documentation.

Keep in mind that this API is mainly geared towards backend functionality such as requesting quota. The actual health check is performed using our web plug-in.

Setup

Environments

As a customer, you will receive information about the environment (API base URL) to use for development and production.

Authentication

All the endpoints described below require an API key or a bearer token in the header for authentication purposes.

API Key

An API key forms a permanent access key to authenticate with the API. Your API key should never be exposed in your front-end and only be used on protected servers and back-end systems.

API keys are sent in the header of the request:
x-api-key: <your-api-key>

Auth endpoints

Get user details

GEThttps://engine.intelliprove.com/v1/auth/me

Use this endpoint to retrieve user information for the current user. The user information defines to which user group and customer you belong.

Request

curl

curl --location 'https://engine.intelliprove.com/v1/auth/me' \
--header 'Accept: application/json' \
--header 'x-api-key: your-api-key'

Response

{
    "email": "sales@intelliprove.com",
    "customer": "intelliprove",
    "group": "contributor"
}

{
    "status": 403,
    "reason": "Missing or invalid authentication credentials."
}

Create action token

POSThttps://engine.intelliprove.com/v1/auth/action-token

Create a new action token with optional custom lifetime and custom metadata. Do not place confidential information in the metadata object. This endpoint can only be called with an API key.

Body parameters

`expire_in`Integer	optional	Lifetime of the token in seconds. Defaults to 6 hours, maximum 12 hours.
`meta`Object	optional	Custom metadata to place in the action token.

Request

curl

curl --location 'https://engine.intelliprove.com/v1/auth/action-token' \
--header 'Content-Type: application/json' \
--header 'x-api-key: your-key' \
--data '{
  "expire_in": 2592000,
  "meta": {}
}'

Response

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImVtYWlsIjoiIiwiY3VzdG9tZXIiOiJ0ZXN0aW5nLWFwaS1rZXkiLCJncm91cCI6ImFkbWluIiwibWF4X21lYXN1cmVtZW50X2NvdW50IjotMX0sIm1ldGEiOnt9LCJleHAiOjE2ODU2NTE1OTl9.uwOflWBIWUVLXFpMzVG3pLRet1Q-9vbzF1XNfpuKTC0"
}

{
    "status": 401,
    "reason": "Missing or invalid authentication credentials."
}

{
    "status": 500,
    "reason": "Could not create new action token"
}

Delete patient data

DELETEhttps://engine.intelliprove.com/v1/patient/data

Delete all results for a specific patient.

Query parameters

`patient-ref`string	optional	Patient for which the health checks are to be deleted.
`performer-ref`string	optional	Additional filter on performer reference.

Request

curl

curl --location --request DELETE 'https://engine.intelliprove.com/v1/patient/data?patient-ref=your-patient-ref&performer-ref=your-performer-ref' \
--header 'x-api-key: your-api-key'

Response

{
    "detail": "Please provide a patient reference."
}

{
    "detail": "Provided patient is not allowed."
}

Account endpoints

Get quota

GEThttps://engine.intelliprove.com/v1/account/quota

Receive information abour your quota and current usage.

Request

curl

curl --location 'https://engine.intelliprove.com/v1/account/quota' \
--header 'x-api-key: your-api-key'

Response

{
    "performed_measurements": 0,
    "quota": 10000,
    "period_start": "2023-06-01T00:00:00",
    "period_stop": "2023-07-01T00:00:00",
    "usage_percentage": 0.0
}

Only admins are allowed to use this request

{
    "detail": "Missing or invalid authentication credentials."
}

Regulatory endpoints

Get CE Label

GEThttps://engine.intelliprove.com/v1/regulatory/ce-label

Request the IntelliProve medical device label

Request

curl

curl --location 'https://engine.intelliprove.com/v1/regulatory/ce-label'

Response

// returns the medical device label as PNG file

Refer to our Instructions for use for more information related to our medical device’s product description and intended use.