FarmMaps/Documentatie
8
0
Fork 0
Code Pull Requests Releases Activity

Update 'README.md'

Browse Source
This commit is contained in:
Wilco Krikke 2021-06-03 10:54:36 +00:00
parent d184c4b194
commit 23f430cd5f
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -11,8 +11,8 @@ The workflow and high-level architecture FarmMaps are documented on the [Farmmap
At the moment, FarmMaps provides two environments for development. At the moment, FarmMaps provides two environments for development.
* https://farmmaps.awtest.nl (testing environment, data is not persistent) * https://test.farmmaps.eu (testing environment, data is not persistent)
* https://farmmaps.awacc.nl (acceptation environment, data IS persistent) * https://acc.farmmaps.eu (acceptation environment, data IS persistent)
When developing your application, using the **acceptation environment is highly recommended**. When developing your application, using the **acceptation environment is highly recommended**.
@ -42,7 +42,7 @@ So, in the authentication flow there are two parties:
* The user logs in at the login page. * The user logs in at the login page.
* On succesfull login, the user is redirected back to your application and the OpenID Provider returns an access token. * On succesfull login, the user is redirected back to your application and the OpenID Provider returns an access token.
Now that the user is back at your applicaiton and the application has an access token, it can then request resources from the OpenID provider. Now that the user is back at your application and the application has an access token, it can then request resources from the OpenID provider.
For each request, the access token needs to be sent along. This access token provides proof that the person sending the request is allowed to access the request and is who he/she claims to be. FarmMaps uses [JWT](https://jwt.io/introduction/) as the format for the access token. For each request, the access token needs to be sent along. This access token provides proof that the person sending the request is allowed to access the request and is who he/she claims to be. FarmMaps uses [JWT](https://jwt.io/introduction/) as the format for the access token.
To continue please see one of the articles below: To continue please see one of the articles below:
@ -52,7 +52,7 @@ To continue please see one of the articles below:
## Using the FarmMaps API ## Using the FarmMaps API
Once you have an access token, you can start querying the API. Once you have an access token, you can start querying the API.
A reference of the API can be found on [the swagger page](https://farmmaps.awacc.nl/swagger) A reference of the API can be found on [the swagger page](https://acc.farmmaps.eu/swagger/)
The API basics are uploading files, creating items and and running tasks to modify or convert data. The API basics are uploading files, creating items and and running tasks to modify or convert data.
For testing purposes, [Postman](https://www.postman.com) can be used to perform HTTP requests more easily. For testing purposes, [Postman](https://www.postman.com) can be used to perform HTTP requests more easily.