Docs

Setup Application

Become an agrirouter partner. Create a developer account, register your application, obtain credentials, and submit for the implementation review.

Becoming an agrirouter integration partner runs on three parallel streams of work: Business and Legal, Development, and Marketing. This page covers the development stream, from creating your developer account to submitting your application for the implementation review.

Loading diagram...

Integration steps

Create a developer account

A developer account is built on top of a regular agrirouter end-user account. It includes everything an end-user account does, plus tools for managing applications, application versions, and developer-specific settings.

To get one:

  1. Sign up for a regular end-user account on the agrirouter platform if you do not already have one.
  2. Request that the account be promoted to a developer account from within your account's settings and then write to support@agrirouter.com. Promotion is reviewed and approved manually.

Two practical conventions:

  • Use a generic company email address (for example, dev@yourcompany.com) rather than a personal one. This keeps the account usable when team members change.
  • Plan on one developer account per app provider. All developers in your organisation share the same account.

Register your application

Once your developer account is active, register your application in the agrirouter UI. You will need to provide:

  • Application name, the name displayed to end users
  • Brand, your company or product brand
  • Application type, the category that best describes your product. Pick Telemetry Platform for a platform that collects and forwards machine or sensor telemetry, or Farming Software for a farm management system. Use Communication Unit only if you are integrating an on-machine terminal or edge device.
  • Support URL, where users can get help with your integration
  • Deep URL, the HTTPS URL where users are sent when they click Connect in the Solution Finder. See Discovery via Deep URL for details.
  • Logo, a visual identifier for your application in the agrirouter ecosystem

A dedicated application type for the current API is planned. Until it is introduced, choose Telemetry Platform or Farming Software based on what your product does today; you will be able to switch to the new type once it is available.

Submit an application version for approval

Each release of your application is represented as an application version. Application versions are created and managed self-service in the developer UI:

  1. You create a new application version yourself, declaring its capabilities and metadata. Capabilities are the message types your application can send and receive (for example, task data, machine descriptions, images)
  2. You submit the application version for approval.
  3. The agrirouter team reviews the submission and updates its status to Approved for Testing.

No credentials are created or transmitted as part of this approval flow. Credentials are handled separately (see the next step).

Obtain credentials

Your application authenticates against agrirouter using OAuth 2.0 client credentials, a client_id and client_secret. These credentials are tied to your application, not to a single application version, and they are used for every customer that authorises your application. See Authorization and Security for the full flow.

Self-service credential creation is on the roadmap. Today, credentials are still issued manually. To request credentials for your application, write to support@agrirouter.com and they will create them on your behalf.

The self-service flow will be: navigate to the credentials area in the developer UI, generate a new client credential pair, and copy or download the values into your secrets store.

Treat the client_secret like a password: never commit it to version control, never log it in plain text, and never expose it in client-side code. Store it in a secrets manager or an environment variable.

Develop your integration

With your application registered and credentials in hand, you can start building the integration. Two notes on how we expect the integration to be built:

There are no official SDKs for the agrirouter API. Generate a client from the OpenAPI specification using a code generator for your language of choice, for example openapi-generator, NSwag, or Prism. The full specification is published on the API Reference, and you can render or browse it directly from there.

We plan to provide thin SDKs that wrap generated clients and/or AI agent instructions to build an SDK.

Use the IO-Tool as your test receiver and sender. The IO-Tool acts as a receiving and/or sending endpoint, so you can send and receive messages without running a second integrated application.

IO-Tool3 min

Submit for implementation review

When your application is ready for production use, let us know and we will run through a review together. For what we look at during the review, see Implementation Review.

Implementation Review3 min

After the review

Once the review has passed, your application status is set to Approved and it becomes available to end users. Your application is listed in the Solution Finder, the public directory on the agrirouter website where farmers, contractors, and agricultural service providers look for approved solutions that integrate with agrirouter. Being listed makes your application discoverable to customers already running agrirouter-connected equipment.

Visit the agrirouter Solution Finder to browse currently listed solutions.

Getting support

If you need help at any stage of setting up your application, write to support@agrirouter.com.

Next steps

For agrirouter's architecture, endpoints, and messaging model, see the concepts section.

Concepts1 min

On this page