ConnexionMenu
API

APIbeta

e-nautia propose une API publique REST. L'URL de base pour tous les appels est : https://api.e-nautia.com
Étant en version beta, l'API est susceptible d'évoluer à tout moment. Inscrivez-vous à la newsletter pour rester informé.

Les accès se font par la méthode HTTP POST, en utilisant le paramètre "token" obtenu après une première authentification. Tous les appels d'API sans erreur retournent un code HTTP 200 avec un objet JSON. Les caractères sont codés en UTF-8.

Lorsqu'une donnée est modifiée, elle est datée au format UTC YYYY-MM-DD HH:ii:ss via une variable "modification".

La suppression de données se fait en deux temps. Une variable associée "del" est à 1, lorsque la ligne a été supprimée et à 0, lorsque la ligne existe toujours. Ainsi, pour supprimer une ligne, il faut l'éditer en mettant la variable "del" à 1. Le serveur e-nautia procédera à la suppression complète au bout d'un mois.

Authentification

Identification

URI : /login

Données à envoyer :

Nom Type Description
login chaîne Identifiant ou adresse e-mail de l'utilisateur
password chaîne Mot de passe de l'utilisateur
lang chaîne Langue à utiliser. Valeurs possibles :
de : allemand
en : anglais
es : espagnol
fr : français
it : italien
jp : japonais
nl : néerlandais
pt : portugais
ru : russe

Réponse, si l'authentification est réussie :

{
"access_token":"ZkcqmSWsKnMSXq5hPpWd",
"expires_in":3600,
"token_type":"Bearer"
}
Variable Description
access_token Valeur à conserver et à réutiliser par l'application
expires_in Durée en secondes pendant laquelle l'utilisation de l'API avec l'access_toen en permise
Au-delà, une nouvelle authentification devra être faite.
token_type Méthode de génération de l'access_token

Réponse, si l'authentification a échoué :

{
"errorCode":2,
"errorMessage":"Le mot de passe est incorrecte."
}
Variable Description
errorCode Code erreur
errorMessage Message d'erreur

Réponse, en cas d'utilisation d'un access_token non valide :

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

Une nouvelle authentification devra alors être faite.

Noms de serveurs mails et FTP

URI : /server

Exemple de réponse :

{
"login":"georges",
"name":"Georges Le Yéti",
"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 Identifiant
name Nom complet
ftpserver Nom du serveur FTP (retourné uniquement si l'accès est autorisé)
imapserver Nom du serveur IMAP (retourné uniquement si l'accès est autorisé)
popserver Nom du serveur POP (retourné uniquement si l'accès est autorisé)
smtpserver Nom du serveur SMTP (retourné uniquement si l'accès est autorisé)
mail Adresse e-mail (retourné uniquement si l'accès est autorisé)

Contacts

Récupérer les contacts

URI : /contacts

Exemple de réponse :

[
{"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 Le Yéti","modification":"2015-01-01 00:00:00"},
"firstname":{"value":"Georges","modification":"2015-01-01 00:00:00"},
"lastname":{"value":"Le Yéti","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"}
}
]

Chaque variable avec une donnée a été enregistrée est retournée.

Données génériques :

Variable Description
id Identifiant unique du contact
value Valeur enregistrée
modification Date de la dernière modification de la donnée associée

Données modifiables :

Nom Type Description
g entier Identifiant de groupe du contact
mail chaîne Adresse e-mail
firstname chaîne Prénom
lastname chaîne Patronyme
organization chaîne Nom d'organisation
fullname chaîne Nom complet
mobilephone chaîne Numéro mobile
homestreet chaîne Adresse de la résidence personnelle
homecity chaîne Ville de la résidence personnelle
homepostalcode chaîne Code postal de la résidence personnelle
homefax chaîne Fax de la résidence personnelle
homephone chaîne Téléphone fixe de la résidence personnelle
birthday date Date de naissance
notes chaîne Note
webpage chaîne Page Web
del entier 0, si on souhaite restaurer le contact
1, si on souhaite supprimer le contact

Ajouter un contact

URI : /contacts/add

Exemple de réponse :

{
"id":111,
{"g":770,"gname":"Amis","modification":"2015-01-01 00:00:00"},
{"email":"contact@e-nautia.com","modification":"2015-01-01 00:00:00"},
{"fullname":"Georges Le Yéti","modification":"2015-01-01 00:00:00"},
{"firstname":"Georges","modification":"2015-01-01 00:00:00"},
{"lastname":"Le Yéti","modification":"2015-01-01 00:00:00"},
{"homecity":"Strasbourg","modification":"2015-01-01 00:00:00"}
}

Les données enregistrées du contact sont retournées avec, pour chacune, la date de dernière modification.

Modifier un contact

URI : /contacts/edit/{id}
({id} à remplacer par la valeur appropriée)

Exemple de réponse :

{
"id":111,
{"g":770,"gname":"Amis","modification":"2015-01-01 00:00:00"},
{"email":"contact@e-nautia.com","modification":"2015-01-01 00:00:00"},
{"fullname":"Georges Le Yéti","modification":"2015-01-01 00:00:00"},
{"firstname":"Georges","modification":"2015-01-01 00:00:00"},
{"lastname":"Le Yéti","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"}
}

Les données enregistrées du contact sont retournées avec, pour chacune, la date de dernière modification.

Catégories de contacts

Récupérer les catégories de contacts

URI : /contacts/groups

Exemple de réponse :

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

Chaque variable avec une donnée a été enregistrée est retournée.

Données génériques :

Variable Description
id Identifiant unique du contact
value Valeur enregistrée
modification Date de la dernière modification de la donnée associée

Données modifiables :

Nom Type Description
name chaîne Nom de la catégorie
del entier 0, si on souhaite restaurer la catégorie
1, si on souhaite supprimer la catégorie

Ajouter une catégorie de contacts

URI : /contacts/groups/add

Exemple de réponse :

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

Les données enregistrées de la catégorie sont retournées avec, pour chacune, la date de dernière modification.

Modifier une catégorie de contacts

URI : /contacts/groups/edit/{id}
({id} à remplacer par la valeur appropriée)

Exemple de réponse :

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

Les données enregistrées de la catégorie sont retournées avec, pour chacune, la date de dernière modification.

Notes

Récupérer les notes

URI : /notes

Exemple de réponse :

[
{"id":11,
"title":{"value":"Tâches à effectuer","modification":"2015-01-01 00:00:00"},
"note":{"value":"Faire le ménage","modification":"2015-01-01 00:00:00"},
"del":{"value":0,"modification":"2015-01-01 00:00:00"}
},
{"id":12,
"title":{"value":"Courses","modification":"2015-01-01 00:00:00"},
"note":{"value":"Des patates et bien plus","modification":"2015-01-01 00:00:00"},
"del":{"value":1,"modification":"2015-01-01 00:00:00"}
}
]

Chaque variable avec une donnée a été enregistrée est retournée.

Données génériques :

Variable Description
id Identifiant unique de la note
value Valeur enregistrée
modification Date de la dernière modification de la donnée associée

Données modifiables :

Nom Type Description
title chaîne Titre
note texte Contenu de la note
del entier 0, si on souhaite restaurer la note supprimée
1, si on souhaite supprimer la note

Ajouter une note

URI : /notes/add

Exemple de réponse :

{
"id":11,
{"title":"Tâches à effectuer","modification":"2015-01-01 00:00:00"},
{"note":"Faire le ménage","modification":"2015-01-01 00:00:00"},
{"del":0,"modification":"2015-01-01 00:00:00"}
}

Les données enregistrées de la note sont retournées avec, pour chacune, la date de dernière modification.

Modifier une note

URI : /notes/edit/{id}
({id} à remplacer par la valeur appropriée)

Exemple de réponse :

{
"id":11,
{"title":"Tâches à effectuer","modification":"2015-01-01 00:00:00"},
{"note":"Faire le ménage","modification":"2015-01-01 00:00:00"},
{"del":0,"modification":"2015-01-01 00:00:00"}
}

Les données enregistrées de la note sont retournées avec, pour chacune, la date de dernière modification.

Calendrier

Récupérer les rendez-vous

URI : /calendar

Exemple de réponse :

[
{"id":99,
"title":{"value":"Soirée entre copains","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":"Chez Bibi","modification":"2015-01-01 00:00:00"},
"del":{"value":1,"modification":"2015-01-01 00:00:00"}
},
{"id":105,
"title":{"value":"Cours","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"}
}
]

Chaque variable avec une donnée a été enregistrée est retournée.

Données génériques :

Variable Description
id Identifiant unique du rendez-vous
value Valeur enregistrée
modification Date de la dernière modification de la donnée associée

Données modifiables :

Nom Type Description
title chaîne Titre
start date & heure Date de début
end date & heure Date de fin
description Notes Description
place texte Adresse
re chaîne Récupérer les rendez-vous
Si il y a des récurrences à appliquer, elles sont séparées par le caractère | et sont présentées comme dans les exemples suivants.
Jour de la semaine : N suivi du numéro du jour (de 1 pour lundi à 7 pour dimanche)
Date dans le mois : d suivi du numéro de la date (de 01 à 31)
Mois : m suivi du numéro du mois (de 01 à 12)
Exemple : |N1|N2|m12| pour une récurrence à appliquer tous les lundi et mardi de décembre
del entier 0, si on souhaite restaurer le rendez-vous supprimée
1, si on souhaite supprimer le rendez-vous

Ajouter un rendez-vous

URI : /calendar/add

Exemple de réponse :

{
"id":99,
{"title":"Soirée entre copains","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":"Chez Bibi","modification":"2015-01-01 00:00:00"}
}

Les données enregistrées du rendez-vous sont retournées avec, pour chacune, la date de dernière modification.

Modifier un rendez-vous

URI : /calendar/edit/{id}
({id} à remplacer par la valeur appropriée)

Exemple de réponse :

{
"id":99,
{"title":"Soirée entre copains","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":"Chez Bibi","modification":"2015-01-01 00:00:00"},
{"del":0,"modification":"2015-01-01 00:00:00"}
}

Les données enregistrées du rendez-vous sont retournées avec, pour chacune, la date de dernière modification.

SMS

Envoyer un SMS

URI : /send/send

Données modifiables :

Nom Type Description
number chaîne Numéro destinataire au format international (+CCXXXXXXXXX où CC est l'indicatif téléphonique et XXXXXXXXX est le numéro local)
message texte Message de 160 caractères maximum

Exemple de réponse :

{
"code":1,
"message":"SMS envoyé"
}

Données génériques :

Variable Description
code Code de retour - Valeurs possibles :
1 : SMS envoyé
2 : numéro incorrecte
3 : crédit insuffisant. Veuillez recharger votre compte.
4 : quota atteint. Veuillez réessayer plus tard.
5 : erreur interne. Veuillez contacter l'assistance.
message Description du code retourné
DeutschEnglishEspañolFrançaisItalianoNederlandsPortuguêsРусский日本の
© e-nautia[FR] ▲ Conditions d'utilisation Suivre e-nautia Contact Aide