Introduction

This API lets you communicate with Climaps to automatize some tasks, such as pulling data for presentation on a third-party website. Usual user accounts are normally denied access to this API, so if you would like to use it please contact us at conta.nosp@m.ct@s.nosp@m.ensor.nosp@m.scop.nosp@m.e.ch.

Usage

The Climaps API is an HTTP-based API using simple GET requests. For example, a request to change settings looks like this:

http://www.climaps.com/api/api.php?key=XXX&api=account&version=1&function=setOwnSettings&language=en&announcements=0

The result of the API functions are JSON objects. For example, the value returned by the setOwnSettings() function presented above looks like this:

{"success": true, "error": ""}

All API calls must include the following parameters:

key: This is an API key provided by Sensorscope. This key is tied to a user account and should never be disclosed.
api: The name of the requested API class (e.g., account, data).
version: The version of the requested API.
function: The name of the function to call.

Other parameters are specific to the function and are described in this documentation.

Recommendations

Although the API key we provide can be tied to any user account, we recommend that you set up a specific user account and give that user the minimum permissions required by the tasks you will be doing with the API.

Please note that using the API with a given API key allows the requester to perform the same actions that a user logged in with the associated account could perform. Hence, to enforce security, it is recommended that the user account to which the API key is tied does not have more permissions than what is needed.

For example, if you will use the API just to pull data from a specific set of stations, only give view permissions to the API user on this exact set of stations. Once the specific user account set up, contact us to get an API key tied to that account.

You are responsible for the security of your API key and the user account the key is tied to. If your API key is compromised, contact us to get a new one. We do not take any responsibility in case of a leaked key or a misuse of the API.