fieldmargin APIs
Our platform
The fieldmargin platform brings all of a farmer's data together in a single place, allowing it to be cross-referenced and informed decisions to be made. Our APIs aim to provide an easy-to-use interface for our partners to add their own data to the platform.
We provide the front-end for farmers to understand their farm and communicate to their team, on web, Android and iOS. Services such as sensor companies may choose to use our front-end as their display layer, rather than creating their own.
Services can use our API to quickly get a user up and running, by taking advantage of their location and existing field boundaries.
If your service has a lot of data or tools then we expect the fieldmargin platform to only show the top-level overview of it. Interested users can dig deeper using your own specialised tools when they need to.
Our APIs
We offer two APIs for you to work with.
- Web API: This is for your integration to call when you require information about a farm or when you want to send data to us.
- Data API: This is for us to call when we need information from you, such as the latest sensor readings.
We work with several types of data:
- Farm: Basic information about the user's farm.
- Fields: The fields and field boundaries on the farm.
- Maps: Imagery of the farm or fields from satellites, drones, drawings or anywhere else.
- Vehicles: Machinery locations and status.
- Sensors: Readings from sensors on the farm or from within vehicles.
- Alerts: Issues that require the attention of farm workers.
Security and privacy
We take the security and privacy of our customer's data very seriously and we strictly control how integrations gain access to this data.
- Integrations must ask the user to approve their integration to be connected to their farm.
- Integrations only gain access to an individual farm, they cannot access other farms that the user may also have access to.
- We use a granular permission structure of each type of data that an integration would like to access. The user must explicitly approve an integration's access to each type of data.
- Integrations can by default only access the data they have created themselves, not any of the other data on the farm.
The full authorization process is detailed in our documentation.
Creating an integration
Note: It currently is not possible to create an integration manually. Please contact us if you are interested in doing so.
When creating an integration you'll be given the following:
client_id: This is the ID you'll use with the OAuth 2.0 authorization flow. It will be used in public-facing URLs and isn't considered secret.client_secret: Also used during the authorization flow when generating access tokens, you must never share this secret as it proves that requests are coming from you.verification_token: A secret token that we put in all requests we send over the the Data API, to let you know that a request has come from us.