Table of Contents. I. How do I register for a new account? II. How do I log in? (I already have a MyJohnDeere.com account.)

Transcription

1 Quick Start Guide If you are an App Developer, you can get started by adding a new app and configuring it to consume Deere APIs on developer.deere.com. Use this Quick Start Guide to find and try our APIs. Table of Contents Registration I. How do I register for a new account? II. How do I log in? (I already have a MyJohnDeere.com account.) App Profile & Team I. How do I create an App Profile? II. How do I create & add members to my App Team? Organizations in MyJohnDeere I. How do I build an organization for my company in MyJohnDeere.com? II. How do I become part of an existing organization? III. Where can I find out more about organizations and files in MyJohnDeere? Apps in the Sandbox I. How do I connect my app to APIs in the sandbox? II. How do I test my app against the sandbox data? Dev Console I. How do I get to the Dev Console? II. OAuth Security III. Basic Auth Security EIC License & Support I. How do I become an EIC Licensee? II. How do I get developer support during app development with Deere APIs?

2 Registration How do I register for a new account? Go to the Develop with Deere site. Click the Login link in the gray box at the top of the page. The MyJohnDeere sign-in form will open in a new window. Click on the Create New Account link towards the bottom right of this form. Fill in both pages of the registration form, and then click the yellow Continue button at the bottom of the page. Fill in the Step Two form of the registration, and then click the yellow Submit button at the bottom of the page. Check the that you just registered your account under. There will be an from do-not-reply@johndeere.com. Click the yellow Validate Profile button in this e- mail. The MyJohnDeere sign-in form will open again, in a new window, with your new username already entered in. Enter in your password, and log in to your new account. Click the yellow Continue Validation button. Go to the Develop with Deere site, and click the Login link in the gray box at the top of the page. You will be redirected to your user profile. How do I log in? On the Develop With Deere site, click the Login link in the gray box at the top of the screen. The MyJohnDeere sign-in form will open. Enter your user ID and password, and click the yellow Sign-In button. You will now be redirected to your Dashboard. If this is your first login, you will need to complete and confirm your user profile before accessing your dashboard. To do this, enter your first and last names, and your address, and then click the gray Finish button. Now you can click on the Dashboard link under your username in the top navigation.

3 App Profile & Team How do I create an App Profile? An App Profile represents the application that you and/or your team is creating. You must have an app profile to request access to our APIs. Your App Profile can have multiple versions. How you create your app profile will depend on which API you plan to connect with. If you are connecting to MyJohnDeere Data API or John Deere Field Connect, you follow these instructions: From the Plus Menu in the top navigation, select Add a New App. This will open the Add App Info page. Enter your app s name and version ID. Choose whether you want your app to be public or private (the private setting will keep your app hidden from other developers). Enter in a short description of your app and version. Click the gray Save button in the bottom right corner of the window. Note: Only one developer per app needs to build the App Profile. If you are connecting to AEMP or AgLogic, follow the directions below to create your app profile: APIAdmin@JohnDeere.com with the subject line AEMP API App Profile or AgLogic App Profile, and provide: The user ID of the JDLink organization whose data you need to access. The name of your company/organization. 2. John Deere site admin will create your App Profile and notify you. You DO NOT need to build an App profile.

4 How do I create my App Team & add members to it? You will need to invite all developers testing with the API Management Tool to your App Team. There are no administrators in an App Team. As new members are added, they will all have the ability to add or remove team members. Click the My Apps icon in the top navigation, and then click on the name of your app. Click on the Team option from the left navigation. Click on the gray Invite More button at the top of the window. This will open the Invite Team Members box. Enter in the addresses of the developers you would like to add to your team. They will all receive an notification with an invitation to your App Team. They can accept their invitations from their dashboards when they log in to developer.deere.com. Organizations in MyJohnDeere How do I build an organization for my company in MyJohnDeere.com? In order to test against sandbox data, you must be part of an organization in MyJohnDeere.com. If you were not redirected upon your first login to build an organization, follow the steps below. To build an organization for your company: Go to the my.deere.com site and log in. You will be redirected to the organization Setup page. Enter the name of your organization. Click on the yellow Let Me In! button.

5 The Data Usage window will pop up. Click the yellow Confirm button at the bottom right corner of the window. Your organization is built! What you re seeing now is your Maps page. From here, you can: Add users to your organization: Click on the portrait icon to view your org. Click the big yellow plus button. The Add A Person dialog box will open. Enter the address of the user you want to add, and then choose their access levels to your organization with the sliding bar options. Click on the Send Invite button at the bottom right corner of the window. The new user will receive an notification, and can now accept your invitation. Upload files to your organization: 1. Click on the folder icon in the gray navigation bar at the top of the screen. 2. Click on the yellow Upload File button, and then choose the files from your computer to upload. How do I become part of an existing organization? You have to be invited to an existing organization to join it. When you re invited, you ll receive an e -mail notification. To accept your invite, click on the yellow Accept Request button in the . You will be redirected to the MyJohnDeere login page. When you log in, you can join the organization. Where can I find out more about organizations and files in MyJohnDeere? More detailed instructions can be found under the Documentation section for the MyJohnDeere Data API. Login to the Develop with Deere site.

6 From your Dashboard, search for MyJohnDeere Data API. Click on the Documentation tab on the left navigation bar. Select your topic of interest from the menu. Apps in the Sandbox How do I connect my app to APIs in the sandbox? First, determine which API(s) you need to use in your app. Then, Search for the API you need, and click on its name. Click on the gray +- Access button to the top right of the window. Select the apps and specific app version you want to connect to this API, and click Next. Select Sandbox for the development of your app, and click Next. Check the appropriate service policy, and click Next. Read and accept the legal agreement, and click Save. Some APIs require approval before you can access them. To see whether the API requires approval, Go to your App Profile (click the My Apps icon, and then click the name of your app). 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. If approval is not required, the page will display the API with a status of Approved. If you request approval, you will receive notification when you have been approved.

7 How do I test my app against the sandbox data? This process is the same as using the Dev Console. Scroll down for instructions on how to use the Dev Console. Dev Console How do I get to the Dev Console? In your account on Develop with Deere, click on the My Apps icon under your username. Then click on the name of the App that you want to test, and select the Dev Console option in the left navigation. OAuth Security (for MyJohnDeere Data API and John Deere Field Connect API: API: Select the API you wish to test in the dropdown. Note: Only APIs that you have been granted access to will appear in this dropdown. For directions to access an API, click here. 2. Endpoint: Select the sandbox or production option, if applicable. 3. Operation: Select the operation you want to test. 4. Method: Select the method you wish to test, if applicable. 5. 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. 6. Content Type: Do not change. 7. Input Parameters: If input parameters exist for the operation, they will be listed with a place for you to input your value.

8 8. 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. 9. 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. 10. Click the yellow Allow button on the bottom right of this window. 11. Click outside the Security Settings box or press Esc on your keyboard. 12. On the Dev Consol page, click on the Run It button. Basic Auth (AEMP or AgLogic): 1. API: Select the AEMP API. 2. Endpoint: Select either Sandbox or Production, if applicable. 3. Operation: Select the operation you wish to test. 4. Method: Select the method you with 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 enter 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. EIC & Support How do I become an EIC Licensee? You must be an EIC Licensee to effectively decode all machine data retrieved with MyJohnDeere Data API. Click here to request information about becoming an EIC Licensee.

9 How do I get developer support during app development with Deere APIs? Fill out this form to create a support ticket. You can also find the support ticket form on the home page of developer.deere.com, by clicking on the Support button.