2020-02-29 16:26:32 +00:00
## Farmmaps Documentation Overview
2020-03-10 10:13:47 +00:00
### The documentation is still work in progress and heavily subject to change!
2020-03-10 09:43:18 +00:00
This page provides an index of the available documentation for the FarmMaps platform.
2020-02-29 16:26:32 +00:00
2020-04-08 16:49:50 +00:00
## 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 ](/wiki/Workflow ) and [FarmMaps Main Components ](/Main-components ) pages.
### Environments
2020-02-29 17:13:20 +00:00
2020-02-29 17:09:15 +00:00
At the moment, FarmMaps provides two environments for development.
* https://farmmaps.awtest.nl (testing environment, data is not persistent)
* https://farmmaps.awacc.nl (acceptation environment, data IS persistent)
When developing your application, using the **acceptation environment is highly recommended** .
2020-04-08 16:49:50 +00:00
### Credentials
To get access to the API, you need an akkerweb development account (akkerweb development and farmmaps development use the same credentials).
These can be created at:
* https://awacc.nl (for the acceptation environment)
* https://awtest.nl (for the testing environment)
### Authentication
To start uploading files, you need to authenticate to the API. The REST API uses OpenID Connect as the protocol.
[Todo: Basic explanation, based of "Authentication.md"]
2020-02-29 17:09:15 +00:00
2020-04-08 16:49:50 +00:00
## How to build a FarmMaps App
- Accessing the API
- Uploading a file
- Checking the file processing status
- Creating a crop field
- Pushing data to MQTT
2020-02-29 16:28:43 +00:00
2020-02-29 16:26:32 +00:00
2020-02-29 16:33:52 +00:00
### Use-case examples
2020-03-11 09:05:00 +00:00
* [VRAPoten-API ](/wiki/VRAPoten-API )
2020-04-07 11:32:04 +00:00
* [VRANbs-API ](/wiki/VRANbs-API )
