Sign inMenu
API

APIbeta

e-nautia now offers you a public REST API. The base URL for all calls is: https://api.e-nautia.com
Being in beta version, the API is likely to evolve at any time. Subscribe to our newsletter to stay informed.

Accesses are made by the POST HTTP method, by using the "token" parameter obtained after the first authentication. All API calls return an HTTP code 200 without consistencies, with a JSON object. Characters are coded using UTF-8.

When a data is modified, it is dated in the UTC YYYY-MM-DD HH:mm:ss format via a "modification" variable.

Removal of data is done in two phases. An associated "del" variable is at 1, when the line has been deleted and at 0, when the line still exists. Hence, in order to delete a line, it must be edited by putting the "del" variable at 1. The e-nautia server will carry out the complete deletion after one month.

Authentication

Identification

URI: /login

Data to be sent:

Name Type Description
login chain Identifier or the user's e-mail address
password chain User's password
lang chain Language to be used. Possible values:
de: German
en: English
es: Spanish
fr: French
it: Italian
pt: Portuguese

Response, if the authentication failed:

{
"access_token":"ZkcqmSWsKnMSXq5hPpWd",
"expires_in":3600,
"token_type":"Bearer"
}
Variable Description
access_token Value to be kept and to be reused by the application
expires_in Duration in seconds, during which the use of the API with the access_token is allowed
Hereafter, a new authentication must be made.
token_type Method of generating the access_token

Response, if the authentication failed:

{
"errorCode":2,
"errorMessage":"Password is incorrect."
}
Variable Description
errorCode Code error
errorMessage Error message

Response, in case of an invalid use of an access_token:

{
"statusCode":401,
"statusMessage":"invalid token"
}

A new authentication will then have to be made.

Names of server e-mails and FTP

URI: /server

Example of a response:

{
"login":"georges",
"name":"Georges The Yeti",
"ftpserver":"e2.e-nautia.com",
"imapserver":"mail.e-nautia.com",
"popserver":"mail.e-nautia.com",
"smtpserver":"mail.e-nautia.com",
"mail":"contact@e-nautia.com"
}
Variable Description
login Identifier
name Full name
ftpserver Name of the FTP server (returned only if the access is authorized)
imapserver Name of the IMAP server (returned only if the access is authorized)
popserver Name of the POP server (returned only if the access is authorized)
smtpserver Name of the SMTP server (returned only if the access is authorized)
mail E-mail address (returned only if the access is authorized)

Contacts

Retrieve contacts

URI: /contacts

Example of a response:

[
{"id":111,
"g":{"value":770,"modification":"2015-01-01 00:00:00"},
"email":{"value":"contact@e-nautia.com","modification":"2015-01-01 00:00:00"},
"fullname":{"value":"Georges The Yeti","modification":"2015-01-01 00:00:00"},
"firstname":{"value":"Georges","modification":"2015-01-01 00:00:00"},
"lastname":{"value":"The Yeti","modification":"2015-01-01 00:00:00"},
"homecity":{"value":"Strasbourg","modification":"2015-01-01 00:00:00"}
},
{"id":112,
"g":{"value":770,"modification":"2015-01-01 00:00:00"},
"email":{"value":"contact@e-nautia.com","modification":"2015-01-01 00:00:00"},
"fullname":{"value":"Big Foot","modification":"2015-01-01 00:00:00"},
"firstname":{"value":"Big","modification":"2015-01-01 00:00:00"},
"lastname":{"value":"Foot","modification":"2015-01-01 00:00:00"},
"homecity":{"value":"Le Havre","modification":"2015-01-01 00:00:00"}
}
]

Every variable with a datum that has been recorded has returned.

Generic data:

Variable Description
id Unique identifier of the contact
value Recorded value
modification Date when the associated data was last modified

Editable data:

Name Type Description
g integer Contact group identifier
mail chain E-mail address
firstname chain First name
lastname chain Surname
organization chain Name of the organization
fullname chain Full name
mobilephone chain Mobile number
homestreet chain Personal residential address
homecity chain Personal residential city
homepostalcode chain Personal residential zip code
homefax chain Personal residential fax number
homephone chain Personal residential landline telephone number
birthday date Date of birth
notes chain Note
webpage chain Web page
del integer 0, if you wish to restore the contact
1, if you wish to delete the contact

Add a contact

URI: /contacts/add

Example of a response:

{
"id":111,
{"g":770,"gname":"Friends","modification":"2015-01-01 00:00:00"},
{"email":"contact@e-nautia.com","modification":"2015-01-01 00:00:00"},
{"fullname":"Georges The Yeti","modification":"2015-01-01 00:00:00"},
{"firstname":"Georges","modification":"2015-01-01 00:00:00"},
{"lastname":"The Yeti","modification":"2015-01-01 00:00:00"},
{"homecity":"Strasbourg","modification":"2015-01-01 00:00:00"}
}

Data recorded as contact are returned with, for each, the last modification date.

Modify a contact

URI: /contacts/edit/{id}
({id} to replace with the appropriate value)

Example of a response:

{
"id":111,
{"g":770,"gname":"Friends","modification":"2015-01-01 00:00:00"},
{"email":"contact@e-nautia.com","modification":"2015-01-01 00:00:00"},
{"fullname":"Georges The Yeti","modification":"2015-01-01 00:00:00"},
{"firstname":"Georges","modification":"2015-01-01 00:00:00"},
{"lastname":"The Yeti","modification":"2015-01-01 00:00:00"},
{"homecity":"Strasbourg","modification":"2015-01-01 00:00:00"}
{"del":1,"modification":"2015-01-01 00:00:00"}
}

Data recorded as contact are returned with, for each, the last modification date.

Contact categories

Retrieve contact categories

URI: /contacts/groups

Example of a response:

[
{"id":770,
"name":{"value":"Friends","modification":"2015-01-01 00:00:00"},
}
{"id":771,
"name":{"value":"Task","modification":"2015-01-01 00:00:00"}
}
]

Every variable with a datum that has been recorded has returned.

Generic data:

Variable Description
id Unique identifier of the contact
value Recorded value
modification Date when the associated data was last modified

Editable data:

Name Type Description
name chain Name of the category
del integer 0, if you wish to restore the category
1, if you wish to delete the category

Add a contact category

URI: /contacts/groups/add

Example of a response:

{
"id":770,
{"name":"Friends","modification":"2015-01-01 00:00:00"}
}

Data recorded as category are returned with, for each, the last modification date.

Modify a contact category

URI: /contacts/groups/edit/{id}
({id} to replace with the appropriate value)

Example of a response:

{
"id":770,
{"name":"Friends","modification":"2015-01-01 00:00:00"},
{"del":0,"modification":"2015-01-01 00:00:00"}
}

Data recorded as category are returned with, for each, the last modification date.

Notes

Retrieve notes

URI: /notes

Example of a response:

[
{"id":11,
"title":{"value":"Tasks to carry out","modification":"2015-01-01 00:00:00"},
"note":{"value":"Cleaning","modification":"2015-01-01 00:00:00"},
"del":{"value":0,"modification":"2015-01-01 00:00:00"}
},
{"id":12,
"title":{"value":"Shopping","modification":"2015-01-01 00:00:00"},
"note":{"value":"Potatoes and much more","modification":"2015-01-01 00:00:00"},
"del":{"value":1,"modification":"2015-01-01 00:00:00"}
}
]

Every variable with a datum that has been recorded has returned.

Generic data:

Variable Description
id Unique identifier of the note
value Recorded value
modification Date when the associated data was last modified

Editable data:

Name Type Description
title chain Title
note text Content of the note
del integer 0, if you wish to restore the note
1, if you wish to delete the note

Add a note

URI: /notes/add

Example of a response:

{
"id":11,
{"title":"Tasks to carry out","modification":"2015-01-01 00:00:00"},
{"note":"Cleaning","modification":"2015-01-01 00:00:00"},
{"del":0,"modification":"2015-01-01 00:00:00"}
}

Data recorded as note are returned with, for each, the last modification date.

Modify a note

URI: /notes/edit/{id}
({id} to replace with the appropriate value)

Example of a response:

{
"id":11,
{"title":"Tasks to carry out","modification":"2015-01-01 00:00:00"},
{"note":"Cleaning","modification":"2015-01-01 00:00:00"},
{"del":0,"modification":"2015-01-01 00:00:00"}
}

Data recorded as note are returned with, for each, the last modification date.

Calendar

Retrieve appointments

URI: /calendar

Example of a response:

[
{"id":99,
"title":{"value":"An evening with friends","modification":"2015-01-01 00:00:00"},
"start":{"value":"2016-01-01 20:00:00","modification":"2015-01-01 00:00:00"},
"end":{"value":"2016-01-01 22:30:00","modification":"2015-01-01 00:00:00"},
"place":{"value":"At Bibi","modification":"2015-01-01 00:00:00"},
"del":{"value":1,"modification":"2015-01-01 00:00:00"}
},
{"id":105,
"title":{"value":"Classes","modification":"2015-01-01 00:00:00"},
"start":{"value":"2016-09-01 09:00:00","modification":"2015-01-01 00:00:00"},
"end":{"value":"2016-06-30 17:30:00","modification":"2015-01-01 00:00:00"},
"re":{"value":"|N1|N2|N3|N4|N5|","modification":"2015-01-01 00:00:00"}
}
]

Every variable with a datum that has been recorded has returned.

Generic data:

Variable Description
id Unique identifier of the appointment
value Recorded value
modification Date when the associated data was last modified

Editable data:

Name Type Description
title chain Title
start date and time Start date
end date and time End date
description Notes Description
place text Address
re chain Retrieve appointments
If there are recurrences to be applied, they are separated by the character | and are presented as in the following examples.
A weekday: N followed by the day number (from 1 for Monday to 7 for Sunday)
A month day: d followed by the day number (from 01 to 31)
Month: m followed by the month number (from 01 to 12)
Example: |N1|N2|m12| for a recurrence to be applied on every Monday and Tuesday of December
del integer 0, if you wish to restore the deleted appointment
1, if you wish to delete the appointment

Add an appointment

URI: /calendar/add

Example of a response:

{
"id":99,
{"title":"An evening with friends","modification":"2015-01-01 00:00:00"},
{"start":"2016-01-01 20:00:00","modification":"2015-01-01 00:00:00"},
{"end":"2016-01-01 22:30:00","modification":"2015-01-01 00:00:00"},
{"place":"At Bibi","modification":"2015-01-01 00:00:00"}
}

Data recorded as appointment are returned with, for each, the last modification date.

Modify an appointment

URI: /calendar/edit/{id}
({id} to replace with the appropriate value)

Example of a response:

{
"id":99,
{"title":"An evening with friends","modification":"2015-01-01 00:00:00"},
{"start":"2016-01-01 20:00:00","modification":"2015-01-01 00:00:00"},
{"end":"2016-01-01 22:30:00","modification":"2015-01-01 00:00:00"},
{"place":"At Bibi","modification":"2015-01-01 00:00:00"},
{"del":0,"modification":"2015-01-01 00:00:00"}
}

Data recorded as appointment are returned with, for each, the last modification date.

SMS

Send an SMS

URI: /send/send

Editable data:

Name Type Description
number chain Recipient number in international format (+CCXXXXXXXXX where CC is the country code and XXXXXXXXX is the local number)
message text Message of 160 characters maximum

Example of a response:

{
"code":1,
"message":"SMS sent"
}

Generic data:

Variable Description
code Return code - Possible values:
1: SMS sent
2: incorrect number
3: insufficient credit. Please recharge your account.
4: quota reached. Please try again later.
5: internal error. Please contact the support.
message Description of the returned code
DeutschEnglishEspañolFrançaisItalianoPortuguês
© e-nautia[EN] ▲ Terms of use Newsletter Contact Help