How does our API work ?

What is Ermeo?

Ermeo is the platform of the connected operator, which means a web and mobile solution designed to digitalize all types of operations and documents. Ermeo will eliminate the use of paper and also tasks with low added value which are slowing down and complicating the daily life of field operators.

To enable automatic data recovery, we also provide our employees with programmatic access to their data via API (application programming interfaces). The API provides a means of accessing data in a reusable and standardized way.

This article explains how our API works and which methods can be used. The other articles in this category will explain the different queries that can be made.

An API is a means of communication between two different applications (or two components of the same application). It allows computer programs to exchange information between them.

Our API is a public API, in order to guarantee the security of our users data. Only authorized users within your company will be able to access your resources. A resource is an object (assets, interventions, users) containing metadatas. Each resource contains its own metadatas.

The Ermeo API is a REST (REpresentational State Transfer) API, making a set of standards which structure the way of communicating data between your application and Ermeo.

This type of API has several advantages :

• Separation of the client and the server, providing a standardized means of communication between the client and Ermeo.
• The fact of being stateless, making each response and each request determined and understandable.
• Being concealable, allowing to decrease the loading time in order to have quicker responses.

Methods usable with our API

GET

The GET method makes it possible to retrieve a single resource (by specifying its id) ​​or a list of resources from Ermeo. The responses to the requests will allow you to retrieve the various information from your resources stored on Ermeo. With this method, information is sent from Ermeo to the requesting client.

POST

The POST method will allow you to create one or more new ressources (documents, assets, users) on Ermeo. Here, the data is therefore sent from the client to Ermeo.

POST (search)

The POST method also allows you to research your resources on Ermeo. You will therefore create your searches using specific filters and sorts.

PUT

The PUT method will allow you to partially modify one or more existing resources on Ermeo. Here, as for the POST method, the information is sent from the client to Ermeo.

DELETE

The DELETE method will allow you to delete one or several resources on Ermeo.

Some basic rules to use our API

How to write the request ?

• URI (Uniform Resource Identifier) ​​must be written in lower case letters
• The name of the collection used must be in the plural.

The key values ​​must have the following formats depending on the types :

• string : surrounded by quotes
• numeric : no quotes
• date : surrounded by quotes and written in standard ISO 8601 format.

Exemple : 

{
 "id": 1024,
 "name": "My document",
 "start_date": "1970-01-01T12:00:27.87+00:20",
 "size" : 2.5
}