Getting Started
Partner setup through sending your first message
agrirouter is a data exchange platform for agriculture. It connects machines, farm management software, and agricultural services, regardless of manufacturer, so they can exchange data with each other.
This section walks you through becoming a partner and sending your first message through the platform. The walk-through covers the cloud_software and virtual_communication_unit integration paths, both of which use the current REST API. If you are building firmware for a physical Communication Unit, jump straight to the Communication Unit guide, which uses the legacy API.
Before you start: what needs involvement of the agrirouter team
Some steps along the way are not self-service (yet). Plan for them up front so they do not block your build:
- Provider agreement (legal). A signed provider agreement with the agrirouter operator is a prerequisite for the implementation review. Start the legal track in parallel with development.
- Developer-account promotion. Sign up for a regular end-user account self-service, then ask the agrirouter team to promote it to a developer account. Promotion is reviewed and approved manually. See Create a developer account.
- Application version approval. You create each application version yourself in the developer UI, but submitting it sends it to the agrirouter team for review; the version becomes usable once they mark it Approved. See Submit an application version for approval.
- Client credentials.
client_idandclient_secretare still issued manually by the agrirouter team. Self-service credential creation is on the roadmap. - Implementation review. Production traffic is gated on a review with the agrirouter team after your QA build is working. See Implementation Review.
Write to support@agrirouter.com early on the manual items so they are not in the critical path.
What you will learn
Setup Application
Become an agrirouter partner: create your developer account, register your application, and submit it for the implementation review
Environments
Understand the QA and Production environments and when to use each
Your First Endpoint
Create your first agrirouter endpoint using the API
Send Your First Message
Send your first message through agrirouter
Receive Your First Message
Receive messages, download payloads, and verify delivery
Before you begin
If you are new to agrirouter, read the pages in order. Each one builds on the previous:
- Setup Application covers the business and technical steps to become an agrirouter integration partner.
- Environments covers the QA and Production environments you will work with during development.
- Your First Endpoint walks through creating an endpoint that can send and receive data.
- Send Your First Message shows you how to send data through agrirouter.
- Receive Your First Message closes the loop by showing you how to receive and verify messages.
Already a partner with a developer account? Skip ahead to Environments or Your First Endpoint.
For agrirouter's architecture and data model, see the concepts section.
Concepts1 min