Short intro to M3G API

M³G offers some of its functionalities through an application programming interface (API). In particular, a RESTful HTTP API that allows you to interact with M³G purely as data that can be uploaded, accessed, searched for, etc. via HTTP requests.

HTTP basically allows you to GET, POST, PUT, DELETE etc. resources on a remote server. These resources are identified via URLs (=uniform resource locator). URLs usually consists of a protocol (e.g. HTTP), a domain (our servers), a path (a place on our servers), and query parameters (additional options).

M³G API: available operations

At present, M³G API provides 5 main "groups" of operations:

• Network
• License
• Metadata, Product and Update (i.e. to get info, export or update some sections of station site logs in M³G, respectively)

Within most of these resource "groups", you find endpoints that either allow you to retrieve info on a given M³G entry (i.e. a network, a station) or to ask a query to locate many M³G entries at the same time (see the M³G Swagger user interface).

M³G API: tools

One can start to test M³G API thanks to different tools and libraries. For example, one could use:

• an HTTP program like curl to directly use M³G API from within a shell
• a generic Python HTTP library such as requests
• the browser, via the M³G Swagger UI, based on an OpenAPI spec, describing some of M³G function calls

In the following sections, you'll find some examples for common M³G tasks using various tools/options.