Skip to content

Commit 110604c

Browse files
authored
Update README.md
1 parent a8d7d5a commit 110604c

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,34 @@
1-
# JDLinkMachineDataAPI-OAuth2-CSharp-Example
1+
2+
# Welcome to the JDLink Machine Data CSharp Example.
3+
4+
This project gives a full native CSharp example of:
5+
* Getting a OAuth2 access token
6+
* Call the JDLink Machine Data APIs with your access token
7+
* Edit Settings
8+
9+
## Requirements
10+
* ASP.NET Core (Current Version: 3.1)
11+
* Installed NuGet Packages:
12+
* Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation Version="3.0.0"
13+
* Microsoft.Extensions.Logging.Debug Version="3.0.0"
14+
* Microsoft.VisualStudio.Web.CodeGeneration.Design Version="3.0.0"
15+
* Newtonsoft.Json Version="12.0.3"
16+
* A free port 9090 (you can change port in: Project Properties-Debug-then App URL).
17+
* The callback for your application needs to be configured for the URL of this app:
18+
* In developer.deere.com, add [http://localhost:9090/callback](http://localhost:9090/callback) as one of the callbacks within OAuth Profile (you can have more than one).
19+
* It is NOT recommended to keep this around for production use.
20+
* You use other ports/URLs and will also needs to be registered in [https://developer.deere.com](https://developer.deere.com/). (Please allow up to 20 minutes for any changes to be replicated).
21+
22+
## Edit Settings
23+
* Once in the browser you will need a few things (Alternative option: update appsettings.json file directly)
24+
* A ClientId and Secret from your application on https://developer.deere.com
25+
* Add Scopes
26+
* Insert scopes, for example org1 org2. Can also be found under JDLink Machine Data API Documentation section within [https://developer.deere.com](https://developer.deere.com/) for each endpoint.
27+
28+
## How to start this project
29+
* Clone this repository:
30+
* ```git clone [email protected]:JohnDeere/JDLinkMachineDataAPI-OAuth2-CSharp-Example.git```
31+
* Build the project
32+
* ```Build Solution```
33+
* Start it
34+
* ```Run IIS Express```

0 commit comments

Comments
 (0)