Access APIs

Once you have created your App Profile, you have to request access to APIs. When your request is approved, you will be able to test in our sandbox. Then, you can request access to production.


Table of Contents

API Access

  1. How do I add APIs to my app?
  2. How do I request access to APIs?
  3. How do I update API access requests?

API Documentation

  1. How do I access API Documentation?

API Versioning

  1. How does API versioning work?
  2. How do I view an API version?

Developer Console

  1. What is the Dev Console, and how do I use it?

Monitoring API Usage

  1. How do I monitor my app's API usage?

API Access

How do I add APIs to my apps?

First, determine which API(s) you need to use in your app. Then,

  1. Search for the API you need, and click on its name.
  2. Click on the gray +- Access button to the top right of the window.
  3. Select the apps and specific app version you want to connect to this API, and click Next.
  4. Select “Sandbox” for the development of your app, and click Next.
  5. Check the appropriate service policy, and click Next.

Some APIs require approval before you can access them. To see whether the API requires approval,

  1. Go to your App Profile (click the My Apps icon, and then click the name of your app).
  2. Click on the APIs option on the left navigation. This will show a list of all the APIs that your app is connected to. If an API requires approval, it will display “Production Access requests require explicit approval from the API provider and may take several days to be granted.” The page will also display a status of “Access Pending.”
  3. If approval is not required, the page will display the API with a status of “Approved.”

How do I request access to APIs?

  1. Go to your App Profile (click the My Apps icon, and then click the name of your app).
  2. Click on the APIs option on the left navigation. This will show a list of all the APIs that your app is connected to.
  3. Click the gray Request Access button next to the name of the API you wish to access. While your request is being reviewed, this page will display the API with an “Access Pending” status.
  4. Once your request is approved, you will receive a notification and this page will display the API with an “Approved” status.

How do I update API access requests?

You may find that you have requested access to the wrong API, the wrong version, or you may decide that you do not need access to the API.

To cancel a pending request/ active connection,

  1. Go to your App Profile (click the My Apps icon, and then click the name of your app).
  2. Click on the APIs option in the left navigation.
  3. Next to the name of the API, you will see a yellow or a green bar and an “Access Pending” or an “Approved” status. Click on the gray Cancel button under this bar.

API Documentation

How do I access API Documentation?

A typical API documentation set will include an overview of the API and developer guides. To access the documentation,

  1. Search for the API and click on its name.
  2. On the left navigation, click on the Documents tab.

API Versioning

How does API Versioning work?

An API may have more than one version available. An app requires separate access to each version of an API, along with access to each environment (sandbox or production) of the API. Please refer to your primary contract agreement with Deere to check how long a sunset version will be supported.

How do I view an API version?

You can view different versions of an API through that API’s profile.

  1. Search for the API and click on its name.
  2. At the upper right corner of the window, next to “Version”, the version ID of the API will display. Use the up and down arrows next to the version ID to select a different version, if they exist.

Developer Console

What is the Dev Console, and how do I use it?

The Dev Console is a web-based client that allows you to test your app’s access to an API.

To use the Dev Console, search for your app, click on its name, and click on the Dev Console tab in the left navigation.

For OAuth Security:

  1. API: Select the API you wish to test in the dropdown.
  2. Note: Only APIs that you have been granted access to will appear in this dropdown. For directions to access an API, click here.

  3. Endpoint: Select the sandbox or production option, if applicable.
  4. Operation: Select the operation you want to test.
  5. Method: Select the method you wish to test, if applicable.
  6. Accept: This information is provided in the API schema. If you have a custom accept header, select “Other” in the dropdown, and specify a header.
  7. Content Type: Do not change.
  8. Input Parameters: If input parameters exist for the operation, they will be listed with a place for you to input your value.
  9. Click the gray Security button next to the End Point dropdown. This will bring up the Security Settings box. Your OAuth credentials will be automatically filled in.
  10. Click on the gray Get Token button. A new window will open, asking you if the App should be allowed access to the API you are trying to connect with.
  11. Click the yellow Allow button on the bottom right of this window.
  12. Click outside the Security Settings box or press Esc on your keyboard.
  13. On the Dev Console page, click on the Run It button.

For AEMP:

  1. Select the AEMP API.
  2. Endpoint--Select Sandbox or Production (if applicable).
  3. Operation – Select the operation you wish to test.
  4. Method – Select the method you wish to test (if applicable).
  5. Accept--Do not change.
  6. Content Type -- Do not change.
  7. Input Parameters – If input parameters exist for the operation, they will be listed with a place to input your value.
  8. Click on the Run It button.
  9. You will be asked to log in. Log in with the JDLink Organization's user ID and password.

Monitoring API Usage

How do I monitor my app's API usage?

You can monitor your app’s API usage through the App Profile.

  1. Search for your app and click on its name.
  2. Click on the Monitor tab in the left navigation.