Skip to main content

Developer Documentation

Dcoumentation Generation

API Reference

The API Reference is generated using our OpenAPI Specifications that are kept in scripts/openapi. These are updated each time a build is run and committed to the repository, so there's no additional work needed to generate these for the docs.

Our APIs are organised as a number of resources group around common services including:

  • Customers
    • Customer, Organisation, Business units and Connections
  • Inventory
    • Commodities, Inventory records, Storage locations and Storage contracts
  • Trading
    • Open and Closed network Listings, Bids and Trading(Sales) contracts
  • Logistics
    • POD implementation for ADM
  • Livestock
    • API for SML v2
  • System
    • Common system related capabilities including Cache, initialisation and files