Getting Started

The developer portal is organised on the basis of Products, which contain one or more APIs and may support different levels of access (e.g. request limits). A developer can subscribe to a Product, which provides a key that is used to access the APIs. This key is specific to the developer account and Product subscription, and will be used for access control and billing (where appropriate).

To find out more about the APIs, including the format of the returned data, select an API from the Product page and explore the available endpoints and the examples of returned data and schema. You can try out the APIs through their documentation pages if you are subscribed.

Subscription keys

To see your current list of keys, click on your name (top right) and then profile.

Your subscription keys should be considered secrets that are only available to you, and should not be shared with other entities or included in source code repositories in any publically-visible place. If you make a call to the APIs without providing a subscription key, or provide a key that is not recognised, you will receive a 401 response indicating that your request has not been authorised.

Accessing Field Explorer

To access the Field Explorer API's:

  • Sign up for an account
  • Verify your account from the e-mail sent to you
  • Sign in to the developer portal
  • Browse the available Products from the menu above
  • Subscribe to Field Explorer
When you first subscribe to a product you will be in Trial mode. Contact Agrimetrics to enable full access.

Using Field Explorer

Calling Field Explorer API's

Field Explorer APIs are accessed by HTTP GET or POST calls, passing in required parameters. The API descriptions describe the parameters in detail. Examples of the responses are given (these are abridged to provide e.g. one representative element per collection, such as a single day or a single month).

Your subscription key needs to be passed in to the API in the HTTP header, and is used for access control and billing (where appropriate).

Each API has at least one functional endpoint, where the main functionality is provided. There is usually also a context endpoint to retrieve the JSON-LD context that describes the response.

JSON-LD

Most API's return data as JSON-LD documents. These are JSON documents with additional semantic type information. They can be parsed in any programming language either directly or through a JSON or JSON-LD library. They can also be loaded into your own graph. The schema describing the content is provided through the context endpoint for each API, giving a JSON-LD document that links the data to the ontology describing the entities in the data and the relationships between them.

More information about linked data and JSON-LD can be found here:

Code Examples

The API Examples GitHub repository contains code examples for all Field Explorer API's

Support

For technical questions please contact Technical Support or raise an issue via issues.