Getting started¶

Exactfarming project documentation

Service Map Structure¶

uml diagram

Brief description¶

For getting an access to API almost all services is required to use authentication token, which can be get through authorization process.

Common authorization schema¶

This scheme assumes that the user already has an account in the system

Registration schema¶

this scheme assumes that the user does not have an account in the system yet

Accounting Workflow (tarif plans, data consumtion)¶

All services allow to limit access to diffirent data, processint, etc.
Limits are controlled by two services Billing and Tarificator which is setup by manager in accordance with the tariff plan and agreements.

Diagram of getting limitis

Services with own authorization¶

Sensor Hub
Weather Hub
Sattelite Hub

have they own token based authorization mechanism, tokens are issuing by corresponding service.
Such approach allows to grant access to different data consumers with there own accounting workflow.
Look at the relevant documentation for details.

Common workflow to get acceess¶

This is the common workflow for getting access to services listed above.
In example below there is used Sensor Hub as the requested service:

Base API Hosts¶

In common cases services are available at base URL:

for production environment: https://api.exactfarming.com

for staging environment: https://api.pl.efarm.pw

Almost all services are availabe at: <base URL>/apps/<app name> or at they own host name, look at the corresponding documentation