Mixfit API docs

docs.md

MixFit prototype API

MixFit prototype API

Version: 1.0.0

/api/v1/me/{public-address}

---

GET

Summary: returns BioCoin balance and reward amount

Description: It is recomended to poll this endpoint from client side to have an actual BioCoin balance.

Parameters

Name	Located in	Description	Required	Schema
public-address	path	Public address of linked ethereum account	Yes	string

Responses

Code	Description	Schema
200	BioCoin balance for particular public-address	Me
400	public-address not allowed

/api/v1/transactions/{public-address}

---

GET

Summary: returns transaction list

Description: It is recomended to poll this endpoint from client side to have an actual transaction list.

Parameters

Name	Located in	Description	Required	Schema
public-address	path	Public address of linked ethereum account	Yes	string

Responses

Code	Description	Schema
200	transaction list for particular public-address	[ Transaction ]
400	public-address not allowed

/api/v1/push-measurement/{public-address}

---

POST

Summary: endpoint to push health Measurement

Parameters

Name	Located in	Description	Required	Schema
public-address	path	Public Address of linked ethereum	Yes	string
body	body	MeasurementData object that needs to be added to the blockchain	No	MeasurementData

Responses

Code	Description	Schema
200	successful operation	object
400	invalid measurement value or invalid public-address

Models

---

Me

Name	Type	Description	Required
public_address	string		Yes
balance	string		Yes
reward_amount	object		Yes

Transaction

Name	Type	Description	Required
id	string (uuid)		Yes
type	string		Yes
status	string		No
registred_at	string		Yes
data_provider	string		Yes
data	MeasurementData		No
reward	string		No

MeasurementData

Name	Type	Description	Required
id	string (uuid)		Yes
type	string	Measurement type	Yes
value	string		Yes
unit	string		Yes