OpenTHC API

A Proposal for Interoperability with a Common Data Model and API

github.com/openthc/api

Regulatory Compliance Data is Complicated and Complex, Closed Systems Are Bad, Interoperability is Key! so we maintain a community driven proposal.


Data Models

The primary purpose of the OpenTHC API are these common data models which have published JSON Schema References.

Examples

Here are some examples, and also links to a JSON-schema definition for validation

These items are defined by YAML in components/schema.

The requirement for common "base" or "type" data is handled by collections of YAML files in ./etc.


Documentation

An API manual is available (also in PDF and RevealJS), to describe some of the modeling and the *why* and *when* operations would be executed.

It provides details on authentication, plants, inventory, transfers, retail sales and the others details necessary to create robust cannabis applications. File a bug if you find any issues.

The OpenAPI documentation has been spun into various formats too: Swagger OpenAPI Reference , OpenAPI HTML , OpenAPI HTML-v2 , and Redoc