Frequently Asked Questions

General

I want to send/retrieve data using an API that is not listed in the documentation. What should I do?

Please reach out to your Climate Corporation business team at partner@climate.com to discuss options.

Do you provide ongoing customer support once my implementation is live?

Yes absolutely! Partner and customer support will be handled by The Climate Corporation’s support team. More information about The Climate Corporation support team can be obtained at support.climate.com

Why should I sign up to be a partner with the Climate FieldView platform?

The Climate FieldView platform is one of the largest digital agriculture platforms in the world with more than 120 million acres and more than 100,000 farmers. Partners get the following benefits by creating new value by being on the platform.

 

  1. Gives partner solutions new applications & higher value
  2. Gets partner solutions in front of growers
  3. Powers partner tools with unique data collection capabilities
  4. Reduces redundant infrastructure investment
How does my company become a Climate FieldView™ platform partner?

Becoming a Climate FieldView platform partner is a simple 3 step process.

  1. Tell us more about your business and understand value creation on the platform.
  2. Talk to your Climate representative and agree on partner terms.
  3. Build and deploy

Just fill out the partner information form to get started

Do I have to pay to get a developer account on the platform?

You do not have to pay to get a developer account on the platform.

Where can I find documentation for current APIs?

You can find API documentation on the dev portal under the “Technical Docs” section.

What are The Climate Corporation’s business terms to access Climate FieldView data?

Please work with your Climate Corporation business team member to discuss terms. You can reach your Climate business team at partner@climate.com

I am concerned about my customer’s data. What data privacy protections do you provide?

The Climate Corporation takes customer data privacy very seriously. Please refer to The Climate Corporation’s existing policy at https://climate.com/legal/privacy-policy.

What kind of technical support do you provide when I am building against your APIs?

We want to make sure our partners have a great experience building against our APIs. We will provide technical support during the implementation process.

Why am I not able to call Climate FieldView Platform APIs via browser?

For security reasons, Climate does not allow making API calls from a browser. You should call the Climate FieldView Platform APIs from your backend service.

Why am I getting the CORS error as shown in the picture below when I try to make API calls on the developer portal? I am able to get the access token; however, I am not able to make API calls.

If you see HTTP 403 forbidden error as shown in the picture above, most likely you have entered your x-api-key incorrectly. Please verify your x-api-key and try again.

 

How can I access the data of those users who have shared operations with the authorized authenticated API user?

Currently, Climate APIs do not support accessing data of the shared users and will only return information belonging to the authorized authenticated user. We recommend all users explicitly connect their partner accounts with the Climate FieldView account. You can find more information about the authentication workflow via this link.

OAuth2 API

Why am I getting a 400 error?

Here are a few reasons why this error is returned:

  1. Sending the client_id and client_secret in the body of the request. This information should instead appear in the authorization header as a basic token.
  2. Using + as a scope delimiter in the authorization_code request. Use spaces instead (e.g., fields:read imagery:write).
  3. Using a refresh_token more than once. Use the newest refresh_token, or create a new token.
  4. Using an authorization_code more than once. Create a new authorization_code.
  5. Sending a redirect_uri in the OAuth request that’s different from the one in the authorization_code request.

Please check out the FieldView OAuth2 Overview page to troubleshoot specific errors.

Agronomic Data APIs

Why am I not getting all the agronomic data after a specific date?

There could be many reasons why you are not able to see the expected data. Some of them are listed below:

  • The grower has not shared the operation with you.
  • There is more than one page of data and you are probably not fetching all the pages of the data.
  • The filter applied on the data is not matching any records.
  • You have already paged through all the records using x-next-token and there is no record left in the result set.
How do I know when new harvest/planting data is available?

The /v4/layers/{asPlanted | asApplied | asHarvested} API provides the filters: occurredBefore, occurredAfter, updatedAfter. Using these filters you can periodically pull new activity data.

When I call the contents endpoint with a range larger than the total length, why am I getting a 206 response code instead of 200?

The current implementation can return 206 or 200 response code whether there is more data or not. You should look for 304 response code as an indicator that no more data is available. Alternatively, the agronomic activity result set returns the length of each activity. You can use the length of the activity to page through the contents of the activity.

How do I update planting or harvest data in Climate FieldView?

To update your planting or harvest data, please follow the steps listed here.

When do planting and harvest activities become available through the APIs? Are they available while they are in progress, or only after Climate FieldView determines that planting or harvesting is complete?

Planting and harvest activities become available through the APIs as soon as an internet connection is established between the FieldView Cab app and Climate’s cloud storage. This connection can be made even while planting or harvest activities are being performed.

Each /v4/layers/[asPlanted|asHarvested|asApplied]/* API response includes a list of fieldIDs. Do these IDs represent the fields in which the activities took place? If so, how are the fields identified in Climate FieldView?

Yes, a fieldID identifies the field in which a given activity took place. Using field boundaries stored in the Cab app and tied to fieldIDs, you  can choose a field manually, set up an alert for a selected field, or schedule automatic updates for a field.

How can I download a user's agronomic data?

The accompanying diagram illustrates the basic steps in downloading agronomic data from Climate FieldView.

Upload APIs

When I upload non–satellite imagery, is there any way to name it?

At present, only satellite imagery can be named.

When calling the /v4/uploads API, can I attach multiple sets of boundaries to a field?

Only one set of boundaries can be attached to each field.

How can I upload multiple images for a given date and time?

You can upload multiple images to a given field for a given date and time as long as the contentType is different.

I uploaded a few files for a grower and received confirmation from Climate that the upload was successful. The grower, however, can’t see the files.

Using the upload API, confirmation of a successful file upload means only that Climate has sent the raw data file to a temporary secure storage area in the cloud. The file is processed later. During this transition, an upload might not show up for a grower. There are two possible reasons for this:

  • Failed import. The image did not import automatically to the grower’s inbox. The grower must log in to the account and import the image manually.
  • Stalled processing. The image was uploaded successfully, but file processing was interrupted or terminated. To check the status of the upload, use the endpoint /v4/uploads/{uploadId}/status.
How does autoimport for non–satellite imagery work?

The autoimport function is pretty complex, but essentially it works like this:

  1. Field Image match. If the image bounds match those of an existing field, the image is autoimported. The boundaries depicted in the image need not match precisely, but the match must meet or exceed a specified consistency threshold, currently set at 70%
  2. Partial image match. If the image bounds fall short of the consistency threshold, the image will be stored securely in the grower’s Data Inbox. He or she will receive notification by email that the image is ready to be imported from Data Inbox.
  3. No image match. If the image bounds fail to match any of the grower’s fields, a new field will be created and the image autoimported as new-field-<uuid>.
  4. Multiple matching fields. If the image bounds match multiple fields, the image will remain in Data Inbox, and the grower will be  notified by email. Log in to Data Inbox to designate the correct field and import the image.