Skip to main content

Quickstart

Start with the guide that every app needs, then pick the path closest to what you are building.

Start here​

→ Getting started: sign in and call the digital farm API — register an app, sign a person in at the platform's identity provider, get a token for the digital farm API, and read and write your first records. It works with the SDK or with any OpenID Connect library, in any language.

Then​

  1. → Fetch data via REST — for frontend and dashboard developers: filters, features, cursors
  2. → Run your first AI service locally — Python + Docker, image-based example
  3. → Push a sensor reading via MQTT — the shortest path to the IoT "aha" moment

Each path is a guided step-by-step with code blocks, expected outputs, and troubleshooting notes.

Before you start​

  • The issuer URL of the platform's identity provider and the base URL of the digital farm API — from the platform operator
  • A developer account with access to at least one farm — the data you read and write belongs to a farm, and your rights on it come from it
  • For the SDK: Python 3.12 or newer