StethoMe API - Vendor (Extended)

GETtoken

{{api_url}}/token

Returns client token.

Generated token must be given to StethoMe SDK for successfull authorization.

Must be authorized with vendor token issued for particular vendor. Vendor token must be kept secret from client devices and must not be shared with any third party.

AUTHORIZATIONBearer Token

Token

Example Request

curl

curl --location -g '{{api_url}}/token'

401 Unauthorized

Example Response

json

{
  "reason": "Invalid token"
}

Content-Type

application/json

GETcheck

{{api_url}}/visit/:visit-id/check

Check processing status of all recordings associated with given visit id.

Will return report for whole visit if processing is finished.

AUTHORIZATIONBearer Token

Token

PATH VARIABLES

visit-id

5c8807d3a8cb9

Visit ID received from StethoMe SDK or /visit route

Example Request

curl

curl --location -g '{{api_url}}/visit/5c8807d3a8cb9/check' \
--header 'Authorization: Bearer {{client_token}}'

200 OK

Example Response

json

{
  "status": "processing"
}

Content-Type

application/json

GETcheck-point

{{api_url}}/visit/:visit-id/recording/:point/check

Check processing status of single recording associated with given visit id.

Will return report for single recording if processing is finished.

AUTHORIZATIONBearer Token

Token

PATH VARIABLES

visit-id

5c8807d3a8cb9

Visit ID received from StethoMe SDK or /visit route

point

Recording No. (1-12)

Example Request

curl

curl --location -g '{{api_url}}/visit/5c8807d3a8cb9/recording/1/check' \
--header 'Authorization: Bearer {{client_token}}'

200 OK

Example Response

json

{
  "status": "completed",
  "point": 1,
  "valid": true,
  "quality": 0.9332,
  "respiratory_rate": 30.13815789473684,
  "tags": {
    "ccg": 0,
    "cfg": 2,
    "whg": 0,
    "wrg": 0
  },
  "ers_phenomenas": {
    "fine crackles": 2
  }
}

Content-Type

application/json

GETtags

{{api_url}}/visit/:visit-id/recording/:point/tags

Get analysed tags for single recording from given visit id.

AUTHORIZATIONBearer Token

Token

PATH VARIABLES

visit-id

5c8807d3a8cb9

Visit ID received from StethoMe SDK or /visit route

point

Recording No. (1-12)

Example Request

curl

curl --location -g '{{api_url}}/visit/5c8807d3a8cb9/recording/1/tags' \
--header 'Authorization: Bearer {{vendor_token}}'

200 OK

Example Response

json

[
  {
    "stop": 0.069787985865724,
    "start": 0.004416961130742,
    "type": "i"
  },
  {
    "stop": 0.29416961130742,
    "start": 0.22173144876325,
    "type": "i"
  },
  {
    "stop": 0.51413427561837,
    "start": 0.43904593639576,
    "type": "i"
  },
  {
    "stop": 0.74028268551237,
    "start": 0.67137809187279,
    "type": "i"
  },
  {
    "stop": 0.97968197879859,
    "start": 0.90459363957597,
    "type": "i"
  },
  {
    "stop": 0.22173144876325,
    "start": 0.073321554770318,
    "type": "e"
  },
  {
    "stop": 0.43904593639576,
    "start": 0.29681978798587,
    "type": "e"
  },
  {
    "stop": 0.67137809187279,
    "start": 0.51501766784452,
    "type": "e"
  },
  {
    "stop": 0.90459363957597,
    "start": 0.74381625441696,
    "type": "e"
  },
  {
    "stop": 0.99646643109541,
    "start": 0.98409893992933,
    "type": "e"
  },
  {
    "stop": 0.050353356890459,
    "start": 0.004416961130742,
    "type": "cfg"
  },
  {
    "stop": 0.28356890459364,
    "start": 0.22791519434629,
    "type": "cfg"
  },
  {
    "stop": 0.3904593639576,
    "start": 0.34717314487633,
    "type": "cfg"
  },
  {
    "stop": 0.51060070671378,
    "start": 0.44611307420495,
    "type": "cfg"
  },
  {
    "stop": 0.60335689045936,
    "start": 0.55388692579505,
    "type": "cfg"
  },
  {
    "stop": 0.73144876325088,
    "start": 0.67579505300353,
    "type": "cfg"
  },
  {
    "stop": 0.84187279151943,
    "start": 0.8030035335689,
    "type": "cfg"
  },
  {
    "stop": 0.96908127208481,
    "start": 0.91166077738516,
    "type": "cfg"
  },
  {
    "stop": 0.14929328621908,
    "start": 0.13515901060071,
    "type": "n"
  },
  {
    "stop": 0.63957597173145,
    "start": 0.63074204946996,
    "type": "n"
  },
  {
    "stop": 0.66519434628975,
    "start": 0.65636042402827,
    "type": "n"
  },
  {
    "stop": 0.68374558303887,
    "start": 0.67491166077739,
    "type": "n"
  },
  {
    "stop": 0.93639575971731,
    "start": 0.91166077738516,
    "type": "n"
  },
  {
    "stop": 0.050353356890459,
    "start": 0.004416961130742,
    "type": "cg"
  },
  {
    "stop": 0.28356890459364,
    "start": 0.22791519434629,
    "type": "cg"
  },
  {
    "stop": 0.3904593639576,
    "start": 0.34717314487633,
    "type": "cg"
  },
  {
    "stop": 0.50795053003534,
    "start": 0.44611307420495,
    "type": "cg"
  },
  {
    "stop": 0.60424028268551,
    "start": 0.55388692579505,
    "type": "cg"
  },
  {
    "stop": 0.72879858657244,
    "start": 0.67579505300353,
    "type": "cg"
  },
  {
    "stop": 0.84275618374558,
    "start": 0.8030035335689,
    "type": "cg"
  },
  {
    "stop": 0.96908127208481,
    "start": 0.91166077738516,
    "type": "cg"
  },
  {
    "stop": 0.047703180212014,
    "start": 0.0070671378091873,
    "type": "pg"
  },
  {
    "stop": 0.28091872791519,
    "start": 0.22879858657244,
    "type": "pg"
  },
  {
    "stop": 0.38957597173145,
    "start": 0.34805653710247,
    "type": "pg"
  },
  {
    "stop": 0.50441696113074,
    "start": 0.4469964664311,
    "type": "pg"
  },
  {
    "stop": 0.60335689045936,
    "start": 0.5547703180212,
    "type": "pg"
  },
  {
    "stop": 0.71554770318021,
    "start": 0.67756183745583,
    "type": "pg"
  },
  {
    "stop": 0.83303886925795,
    "start": 0.80388692579505,
    "type": "pg"
  },
  {
    "stop": 0.96554770318021,
    "start": 0.91254416961131,
    "type": "pg"
  }
]

Content-Type

application/json