API Overview - Health123/wiki GitHub Wiki

The Romulus API provides access to configure, read, and write data objects and templates within the Health123 Platform.

Concepts

Discussion of the conceptual model.

• Signals
• Steps
• Documents
• Messages
• Labels
• Callbacks

API Calling Conventions

All Romulus endpoints receive HTTPS PUT or POST requests, and require TLS 1.0 or greater. Request parameters are passed as JSON in the request body. The Content-Type request header should be set to application/json.

Since all requests have a JSON request body, the GET verb is not used. All requests include version and api_key attributes in the JSON request body.

Types

Some data types are used frequently and are briefly outlined here.

UUID

IDs throughout the API are Version 5 UUID type in the string format:

"hhhhhhhh-hhhh-hhhh-hhhh-hhhhhhhhhhhh"

ISO 8601 Timestamps

Timestamps are in ISO 8601, always converted to UTC, and expressed in this string format:

"yyyy-mm-ddThh:mm:ssZ"

A greater subset of ISO 8601 may be accepted in the future, e.g. adding milliseconds or allowing an abbreviated form of date only.

Example Workflows

This section demontrates actual request and response JSON structure for various workflows.

• Configure biometric types
• Record biometric values
• Assign biometric types to a group
• Add goal for biometric target
• Retrieve previously recorded values

Endpoint Reference

Health123 API Reference

External Tools

Postman is a convenient way to explore JSON APIs.