fix url
Mark van der Wal
parent
a48f5c9625
commit
588b700a84
|
|
@ -1,7 +1,7 @@
|
|||
# Integrating FarmMaps OpenID Connect
|
||||
Farmmaps uses OpenID Connect (OIDC).
|
||||
This page lists the information needed to integrate OpenID connect into your application.
|
||||
Note that for testing purposes it is quicker to just [generate an access token]() instead of implementing a complete integration.
|
||||
Note that for testing purposes it is quicker to just [generate an access token](.md) instead of implementing a complete integration.
|
||||
Please see [https://openid.net/connect/](https://openid.net/connect/) if you are not familiar with OpenID Connect.
|
||||
|
||||
To integrate OIDC, it is recommended to use a (certified) library/implementation for your language of choice:
|
||||
|
|
@ -21,7 +21,7 @@ More about flow types can be found [here](https://www.scottbrady91.com/OpenID-Co
|
|||
|
||||
* At the moment, FarmMaps does not support dynamic client registration.
|
||||
Please request a client id from one of our developers when you need one for your application.
|
||||
In the meantime, it is recommended to simply [generate an access token]() to explore the REST API.
|
||||
In the meantime, it is recommended to simply [generate an access token](.md) to explore the REST API.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -73,14 +73,14 @@ There's also swagger based reference of the [REST API](https://farmmaps.awacc.nl
|
|||
#### MQTT Endpoint
|
||||
The MQTT Endpoint provides a way to input more stream like data like a live GPS location, or live temperature measurement to FarmMaps.
|
||||
This endpoint is still under development. If you would like to build on top of this endpoint, please contact the FarmMaps development team.
|
||||
As a reference, please also see [Sending data to MQTT](Message-Queue-Endpoint).
|
||||
As a reference, please also see [Sending data to MQTT](Message-Queue-Endpoint.md).
|
||||
|
||||
### Data processing infrastructure
|
||||
To process the data that is provided through the endpoints, FarmMaps uses queues and workers to manage the execution of these tasks.
|
||||
How this works is described in [the workflow article](Workflow)
|
||||
How this works is described in [the workflow article](Workflow.md)
|
||||
|
||||
### Viewer
|
||||
To visualize all data in the FarmMaps backend, FarmMaps integrates it's own viewer.
|
||||
This viewer is available as an open source project and can be found in the [FarmMapsLibs Repository](https://git.akkerweb.nl/FarmMaps/FarmMapsLib).
|
||||
There's also a separate documentation page which can be found [here](FarmMapsLibs). [under development]
|
||||
There's also a separate documentation page which can be found [here](FarmMapsLibs.md). [under development]
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ The same workflow can be followed for different languages, as long as there's a
|
|||
FarmMaps provides an MQTT endpoint to allow your application to send signals to FarmMaps, and listen for events.
|
||||
These signals are collected in a "message queue".
|
||||
|
||||
If you are not familiar with anything mentioned, please see the [FAQ](#faq) at the end.
|
||||
If you are not familiar with anything mentioned, please see the [FAQ](#faq.md) at the end.
|
||||
|
||||
### Prerequisites
|
||||
To follow along with the examples, you need:
|
||||
|
|
@ -162,7 +162,7 @@ For now, we'll stick with the pregenerated protobuf class.
|
|||
* [Protobuf documentation](https://developers.google.com/protocol-buffers/docs/overview)
|
||||
* [Paho MQTT documentation](https://www.eclipse.org/paho/clients/python/docs/)
|
||||
|
||||
## [FAQ](#faq)
|
||||
## [FAQ](#faq.md)
|
||||
#### How do I install the required Python modules?
|
||||
This tutorial requires the `paho-mqtt` and `protobuf` modules.
|
||||
These can be installed with the following commands:
|
||||
|
|
|
|||
18
README.md
18
README.md
|
|
@ -5,7 +5,7 @@ This page provides an index of the available documentation for the FarmMaps plat
|
|||
## Getting started
|
||||
The main starting point for Farmmaps API access is the REST API.
|
||||
To get started, follow the steps below.
|
||||
The workflow and high-level architecture FarmMaps are documented on the [Farmmaps Workflow](Workflow) and [FarmMaps Main Components](Main-components) pages.
|
||||
The workflow and high-level architecture FarmMaps are documented on the [Farmmaps Workflow](Workflow) and [FarmMaps Main Components](Main-components.md) pages.
|
||||
|
||||
### Environments
|
||||
|
||||
|
|
@ -47,8 +47,8 @@ For each request, the access token needs to be sent along. This access token pro
|
|||
|
||||
To continue please see one of the articles below:
|
||||
|
||||
- [Integrating FarmMaps Open ID Connect into your application](Integrating-FarmMaps-OIDC)
|
||||
- [Creating an access token for testing.](Create-access-token)
|
||||
- [Integrating FarmMaps Open ID Connect into your application](Integrating-FarmMaps-OIDC.md)
|
||||
- [Creating an access token for testing.](Create-access-token.md)
|
||||
|
||||
## Using the FarmMaps API
|
||||
Once you have an access token, you can start querying the API.
|
||||
|
|
@ -57,17 +57,17 @@ The API basics are uploading files, creating items and and running tasks to modi
|
|||
For testing purposes, [Postman](https://www.postman.com) can be used to perform HTTP requests more easily.
|
||||
|
||||
We provide the following guides:
|
||||
* [Uploading a file](Upload-a-file)
|
||||
* [Creating a cropfield](Create-a-cropfield)
|
||||
* [Running a task](Running-tasks)
|
||||
* [Uploading a file](Upload-a-file.md)
|
||||
* [Creating a cropfield](Create-a-cropfield.md)
|
||||
* [Running a task](Running-tasks.md)
|
||||
|
||||
Generally, tasks can be run in the same way.
|
||||
However, each specific task has it's own inputs and properties.
|
||||
How these work can be found in the use task examples below.
|
||||
|
||||
### <a name="task-examples"></a>Task examples
|
||||
* [VRAPoten-API](VRAPoten-API)
|
||||
* [VRANbs-API](VRANbs-API)
|
||||
* [VRAHerbicide-API](VRAHerbicide-API)
|
||||
* [VRAPoten-API](VRAPoten-API.md)
|
||||
* [VRANbs-API](VRANbs-API.md)
|
||||
* [VRAHerbicide-API](VRAHerbicide-API.md)
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -259,7 +259,7 @@ Vary: Accept-Encoding
|
|||
|
||||
## What's next?
|
||||
Now that you know how to run a task, you can start running specialized tasks to create or process your own data.
|
||||
Head over to the [Task Examples](Home#task-examples)
|
||||
Head over to the [Task Examples](Home#task-examples.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ The workflow for uploading a file is as follows:
|
|||
* Downloading the file to check (optional)
|
||||
|
||||
**Prerequisites**
|
||||
- To be able to perform requests, make sure you have an [access token](Create-access-token).
|
||||
- To be able to perform requests, make sure you have an [access token](Create-access-token.md).
|
||||
|
||||
### Registering the upload
|
||||
Before a file can be uploaded it needs to be registered. Files smaller than 2 MB can be uploaded in one chunk.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
## VRAHerbicide API
|
||||
[<< Home](Home)
|
||||
[<< Home](Home.md)
|
||||
|
||||
FarmMaps is an asynchronous architecture, the API flow keeps this in mind.
|
||||
The API expects that all data is already processed and available provided, for example through the normal FarmMaps flow (frontend).
|
||||
|
|
@ -12,7 +12,7 @@ For the currently available public FarmMaps API you can take a look at swagger:
|
|||
|
||||
**Users can poll the task api to see if a task is completed**
|
||||
**This can be achieved with the task execution id obtained from calling the 'ItemTask' API.**
|
||||
[Poll task status](Polling-task-status)
|
||||
[Poll task status](Polling-task-status.md)
|
||||
|
||||
**Users can query the API for child items of a cropfield to see what items it has.**
|
||||
|
||||
|
|
@ -30,11 +30,11 @@ For the currently available public FarmMaps API you can take a look at swagger:
|
|||
* Download item data (tiff of shape)
|
||||
|
||||
### Steps
|
||||
[Authentication](Authentication)
|
||||
[Authentication](Authentication.md)
|
||||
|
||||
##### Optional
|
||||
[Create Cropfield](Create-Cropfield)
|
||||
[Upload Data](Upload-Data)
|
||||
[Create Cropfield](Create-Cropfield.md)
|
||||
[Upload Data](Upload-Data.md)
|
||||
|
||||
###### Transform shape to geotiff
|
||||
The VRAHerbicide task only processes tiff items as input.
|
||||
|
|
@ -163,7 +163,7 @@ Response 403 No WRITE permissions in item
|
|||
Response 404 Item not found
|
||||
|
||||
##### Create taskmap
|
||||
[Create Taskmap](Create-Taskmap)
|
||||
[Create Taskmap](Create-Taskmap.md)
|
||||
|
||||
##### Download the data
|
||||
In case the data is available it can be downloaded with the File API.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
## VRANbs API v0.2
|
||||
[<< Home](Home)
|
||||
[<< Home](Home.md)
|
||||
|
||||
FarmMaps is an asynchronous architecture, the API flow keeps this in mind.
|
||||
The API expects that all data is already processed and available provided, for example through the normal FarmMaps flow (frontend).
|
||||
|
|
@ -17,7 +17,7 @@ For the currently available public FarmMaps API you can take a look at swagger:
|
|||
|
||||
**Users can poll the task api to see if a task is completed**
|
||||
**This can be achieved with the task execution id obtained from calling the 'ItemTask' API.**
|
||||
[Poll task status](Polling-task-status)
|
||||
[Poll task status](Polling-task-status.md)
|
||||
|
||||
**Users can query the API for child items of a cropfield to see what items it has.**
|
||||
|
||||
|
|
@ -38,11 +38,11 @@ For the currently available public FarmMaps API you can take a look at swagger:
|
|||
* Download item data (tiff of shape)
|
||||
|
||||
### Steps
|
||||
[Authentication](Authentication)
|
||||
[Authentication](Authentication.md)
|
||||
|
||||
##### Optional
|
||||
[Create Cropfield](Create-Cropfield)
|
||||
[Upload Data](Upload-Data)
|
||||
[Create Cropfield](Create-Cropfield.md)
|
||||
[Upload Data](Upload-Data.md)
|
||||
|
||||
###### Transform shape to geotiff
|
||||
The VRANbs task only processes tiff items as input.
|
||||
|
|
@ -286,7 +286,7 @@ Response 403 No WRITE permissions in item
|
|||
Response 404 Item not found
|
||||
|
||||
##### Create taskmap
|
||||
[Create Taskmap](Create-Taskmap)
|
||||
[Create Taskmap](Create-Taskmap.md)
|
||||
|
||||
##### Download the data
|
||||
In case the data is available it can be downloaded with the File API.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
## VRAPoten API v0.1.1
|
||||
[<< Home](Home)
|
||||
[<< Home](Home.md)
|
||||
|
||||
FarmMaps is an asynchronous architecture, the API flow keeps this in mind.
|
||||
The API expects that all data is already processed and available provided, for example through the normal FarmMaps flow.
|
||||
|
|
@ -14,7 +14,7 @@ For the currently available public FarmMaps API you can take a look at swagger:
|
|||
|
||||
**Users can poll the task api to see if a task is completed**
|
||||
**This can be achieved with the task execution id obtained from calling the 'ItemTask' API.**
|
||||
[Poll task status](Polling-task-status)
|
||||
[Poll task status](Polling-task-status.md)
|
||||
|
||||
### API flow
|
||||
* Authenticate User
|
||||
|
|
@ -30,13 +30,13 @@ For the currently available public FarmMaps API you can take a look at swagger:
|
|||
|
||||
### Steps
|
||||
###### Authentication
|
||||
[Authentication](Authentication)
|
||||
[Authentication](Authentication.md)
|
||||
|
||||
###### Create cropfield with FarmMaps API (optional)
|
||||
[Create Cropfield](Create-Cropfield)
|
||||
[Create Cropfield](Create-Cropfield.md)
|
||||
|
||||
###### Uploading own data (optional)
|
||||
[Upload Data](Upload-Data)
|
||||
[Upload Data](Upload-Data.md)
|
||||
|
||||
###### Creating appliance maps
|
||||
Execute the VRAPotenTask with the item code of the cropfield as parameter inside {code}.
|
||||
|
|
@ -75,7 +75,7 @@ Response 403 No WRITE permissions in item
|
|||
Response 404 Item not found
|
||||
|
||||
###### Create taskmap
|
||||
[Create Taskmap](Create-Taskmap)
|
||||
[Create Taskmap](Create-Taskmap.md)
|
||||
|
||||
###### Download the data
|
||||
In case the data is available it can be downloaded with the File API.
|
||||
|
|
|
|||
Loading…
Reference in New Issue