Open Telematics API

A project to enable business resiliency for motor freight carriers with tight integrations into Telematics Service Providers (TSPs).

This repository hosts the v1.0 release formal specification of the Open Telematics API; in API Blueprint format 1A.

The specification is pubished in various forms:

• here, in
  • apiary.apib -- API Blueprint specification
  • otapi.html -- standalone documentation rendering of the above
• at opentelematicsapi.docs.apiary.io as:
  • Interactive documentation
  • A mock server
• at apimatic/.../nmfta-opentelematics-api as:
  • Exportable API specifications in multiple formats including: Open API 3.0, RAML 1.0, and Swagger 2.0
  • Downloadable (client) SDKs in .NET and Python

There is also a prototype implementation of version 0.1rc4 of this specificiation available at github.com/nmfta-repo/nmfta-opentelematics-prototype.

Finally, a questionnaire for use by motor freight carriers in assessing the degree to which a TSP provides OTAPI support is also available: Open Telematics Supported Use Cases Questionnaire.xlsx

Contributors

This Open Telematics API was made possible through the generous contributions of thought leadership and technical expertise of many collaborators across the heavy vehicle cyber security community, working to push the industry forward and make it more resilient. Though some of our contributors wish to remain anonymous, we are deeply grateful to everyone who has given their time and energy to make this a reality.

Regenerating Standalone Documentation

The otapi-*.html standalone documentation files are generated by using the aglio tool on the apiary.apib API Blueprint file. To re-generate the standalone document, follow the following steps:

1. install aglio:

npm install -g aglio #tested on node lts/boron v6.17.1

2. install the custom aglio theme, aglio-theme-olio-printing

npm install -g aglio-theme-olio-printing

3. run the generateme script in this repo

bash generateme.sh