API

These sections detail the external (i.e. REST/Websocket) as well as the internal (i.e. Classes/Functions) API (opens new window) of Weacast.

You might read this introduction article (opens new window) about using Feathers in production because it has been used as a guideline for the development Weacast.

TIP

All dates/times in Weacast are managed as moment (opens new window) objects and expressed in UTC (opens new window).

Testing

You will find here (opens new window) a collection of ready-to-go REST requests to test the API with the great POSTMAN (opens new window) tool. Simply download it and import it in your POSTMAN installation.

You should do the following:

1. make your Weacast installation run (the collection is configured for default dev port 8080 but you can easily switch to 8081 for production mode for instance or any other)
2. use the authenticate request with a registered user e-mail/password to retrieve an authorization token
3. set this token in the header of other requests in order to be authorized to perform the request
4. renew your token when expired (step 2)