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-02-29 17:13:20 +00:00
|
|
|
### Getting started
|
|
|
|
|
|
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**.
|
|
|
|
|
|
|
|
|
|
The process for obtaining access to API's varies slightly per API.
|
|
|
|
|
Each API documentation page describes this for its own API.
|
|
|
|
|
|
2020-03-01 10:14:16 +00:00
|
|
|
### FarmMaps Main Concepts
|
2020-02-29 16:26:32 +00:00
|
|
|
* The datastore
|
|
|
|
|
* Endpoints
|
|
|
|
|
* Workers
|
|
|
|
|
* Queues
|
|
|
|
|
* File-chains
|
2020-02-29 16:30:53 +00:00
|
|
|
* [Viewer (FarmMapsLibs)](/wiki/FarmMapsLibs)
|
2020-02-29 16:28:43 +00:00
|
|
|
|
2020-02-29 16:28:53 +00:00
|
|
|
### API Documentation
|
2020-02-29 16:26:32 +00:00
|
|
|
FarmMaps provides 3 main endpoints to build services upon.
|
|
|
|
|
|
|
|
|
|
* A file upload/download API (REST) for file uploads in chunks.
|
|
|
|
|
* An FTP endpoint to upload files through FTP
|
2020-02-29 16:34:19 +00:00
|
|
|
* [A message queue endpoint (MQTT)](/wiki/Message-Queue-Endpoint) to recieve streaming data and send and recieve triggering signals.
|
2020-02-29 16:26:32 +00:00
|
|
|
|
2020-02-29 16:33:52 +00:00
|
|
|
### Use-case examples
|
2020-02-29 16:28:02 +00:00
|
|
|
* [VRAPoten-API](/wiki/VRAPoten-API)
|
