API REST

Posted on Jui 09, 20 at 03:06 PM

Mis à jour le 11/06/2020

Pré requis

Un compte de paramétrage et un token associé

Le compte de paramétrage permettra de se connecter à l'application web

Le token permettra d'utiliser le web service

Le compte et le token sont fournis par Inarcom

2 types de comptes de paramétrage existent: global et local. Le compte de paramétrage global donne accès à tous les interlocuteurs, il permet permet d'en créer, d'accéder à tous les messages du serveur. Le compte de paramétrage local est lié à un interlocuteur uniquement.

Identification pour utiliser le web service

Dans l'entête de l'URL un paramètre Authorization doit être créé avec la valeur: Bearer {token} (sans les {})

exemple: Authorization: Bearer d5e385f9e40cdb1232a8746809f217b1

Format de la réponse

Par défaut: JSON

Pour avoir une réponse en XML, mettre dans l'entête : Accept: application/xml

Erreurs globales à toutes les requêtes

Erreur d'identification	Description
{ "err_msg": "Un mot de passe vide n'est pas autorisé", "err_code": 403, "response_id": "", "api": "", "version": "", "data": {} }	Vérifier qu'un token a bien été passé dans l'entête

Erreur d'identification	Description
{ "err_msg": "API Key Not Found", "err_code": 403, "response_id": "", "api": "", "version": "", "data": {} }	Le token n'est pas reconnu

Erreur de configuration	Description
{ "err_msg": "PLG_API_NOT_AVAILABLE_IN_THIS_MODE", "err_code": 501, "response_id": "", "api": "", "version": "", "data": {} }	Les API ne sont pas disponibles avec le paramétrage actuel du serveur

Erreur de requête	Description
{ "err_msg": "PLG_API_PUT_METHOD_NOT_ALLOWED", "err_code": 501, "response_id": "", "api": "", "version": "", "data": {} }	La méthode demandée n'est pas implémentée

Erreur de requête	Description
{ "err_msg": "PLG_API_DELETE_METHOD_NOT_ALLOWED", "err_code": 501, "response_id": "", "api": "", "version": "", "data": {} }	La méthode demandée n'est pas implémentée

ERREUR

Description

{
    "err_msg": "",
    "err_code": "",
    "response_id": "5edf9e101a199",
    "api": "tablomail.interlocuteurs",
    "version": "",
    "data": {
        "status": false,
        "code": "500",
        "message": "PLG_API_CATEGORY_ERROR_WHILE_UPDATING_BDD"
    }
}

La mise à jour de la base de donnée a échouée.

Contactez la maintenance en indiquant le détail de la requête effectuée

Interlocuteurs ( tableaux virtuels)

Demande

Méthode

URL

Paramètre URL

Paramètre Body (JSON)

Description

GET

/api-rest/tablomail/interlocuteurs/

email_interlocuteur (optionnel)

Si email_interlocuteur n'est pas passé, renvoi la liste de tous les tableaux auxquels a droit l'utilisateur ( un compte de paramétrage local n'a droit qu'à accéder à un seul interlocuteur attaché à son compte)

Sinon envoi les informations d'un tableau en particulier

exemples:

https://{server}/api-rest/tablomail/interlocuteurs/

https://{server}/api-rest/tablomail/interlocuteurs?email_interlocuteur=Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.

Réponses

REPONSE CORRECTE

Description

{
    "err_msg": "",
    "err_code": "",
    "response_id": "5edf8eefec1a9",
    "api": "tablomail.interlocuteurs",
    "version": "",
    "data": [
        {
            "nom": "Copropriété de résidence du Grand Lyon",
            "date_adhesion": "2017-10-11 22:00:00",
            "email": "Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.",
            "qr_code": "https://conseil-syndical-copropriete.fr/commandes?commande=CmD3&no_r=3&deft=0&nom=Copropri%C3%A9t%C3%A9+de+r%C3%A9sidence+du+Grand+Lyon"
        }
    ]
}

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee258e226f07", "api": "tablomail.interlocuteurs", "version": "", "data": { "status": false, "code": "404", "parametre": "email_interlocuteu", "message": "PLG_API_EMAIL_INTERLOCUTEUR_NOT_FOUND" } }	Le paramètre fourni n'a pas été reconnu

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5edf9e101a199", "api": "tablomail.interlocuteurs", "version": "", "data": { "status": false, "code": "404", "email": "Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.", "message": "PLG_API_INTERLOCUTEUR_NOT_FOUND" } }	L'interlocuteur fourni est erroné

Erreur d'identification	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee25aca77f8d", "api": "tablomail.interlocuteurs", "version": "", "data": { "status": false, "code": "403", "email": "Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.", "message": "PLG_API_USER_MISSING_RIGHTS" } }	L'utilisateur n'a pas les droits nécessaires pour réaliser la requête demandée

Catégories

Les catégories permettent d'organiser les informations.

Une catégorie a 3 propriétés:

- Nom

- Visibilité (tous, conseil, coproprietaires)

Seules les catégories à la visibilité 'tous' sont affichées par l'interface sans qu'il soit nécessaire de se connecter

- Expiration

Demande

Méthode

URL

Paramètre URL

Paramètre Body (JSON)

Description

PUT

/api-rest/tablomail/categories/

nom_categorie

expiration

Mise à jour de la valeur de l'expiration associée à une catégorie ( en nombre de jours)

si expiration = 0 pas d'expiration des messages de la catégorie correspondante

exemples:

https://{server}/api-rest/tablomail/categories?nom_categorie=pannes

Contenu body:

{"expiration":"90"}

Réponses

REPONSE CORRECTE	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee234967720c", "api": "tablomail.categories", "version": "", "data": { "status": true, "nom": "pannes", "expiration": "100", "code": "200", "message": "PLG_API_CATEGORY_EDITED_SUCCESSFULLY_MESSAGE" } }

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee233bdbef61", "api": "tablomail.categories", "version": "", "data": { "status": false, "nom": null, "code": "404", "message": "PLG_API_CATEGORY_NOT_FOUND" } }	Le paramètre 'catégorie' n'a pas été trouvé dans l'URL de la requête

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee2342506c22", "api": "tablomail.categories", "version": "", "data": { "status": false, "nom": "test", "code": "404", "parametre": "expiration", "message": "PLG_API_EXPIRATION_NOT_FOUND" } }	Le paramètre 'expiration' n'a pas été trouvé dans le body de la requête

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee2345ed0039", "api": "tablomail.categories", "version": "", "data": { "status": false, "nom": "pannes", "expiration": "a", "code": "400", "message": "PLG_API_CATEGORY_ERROR_EXPIRATION_VALUE" } }	Le paramètre 'expiration' existe mais erreur sur la valeur (doit être numérique)

ERREUR

Description

{
    "err_msg": "",
    "err_code": "",
    "response_id": "5ee2343ece08b",
    "api": "tablomail.categories",
    "version": "",
    "data": {
        "status": false,
        "nom": "test",
        "expiration": "a",
        "code": "403",
        "message": "PLG_API_CATEGORY_TEST_CANT_BE_MODIFIED"
    }
}

La catégorie test ne peut pas être modifiée

Cette catégorie est spéciale et sert à savoir si un expéditeur email est autorisé à envoyer des messages

Méthode

URL

Paramètre URL

Paramètre Body (JSON)

Description

GET

/api-rest/tablomail/categories/

nom_categorie (optionnel)

Liste des catégories

Si nom de catégorie saisi, alors affichage des informations de la catégorie demandée

Si nom de catégorie non saisi, affichage des informations de toutes les catégories

exemples:

https://{server}/api-rest/tablomail/categories

https://{server}/api-rest/tablomail/categories?nom_categorie=pannes

Contenu body:

Réponses

REPONSE CORRECTE

Description

{
    "err_msg": "",
    "err_code": "",
    "response_id": "5ee1ff5796e42",
    "api": "tablomail.categories",
    "version": "",
    "data": {
        "informations": {
            "nom": "informations",
            "expiration": "90",
            "visibilite": "tous"
        },
        "pannes": {
            "nom": "pannes",
            "expiration": "90",
            "visibilite": "tous"
        },
        "interventions-sur-site": {
            "nom": "interventions-sur-site",
            "expiration": "90",
            "visibilite": "tous"
        },

...

        "contrats": {
            "nom": "contrats",
            "expiration": "",
            "visibilite": "conseil"
        },
        "test": {
            "nom": "test",
            "expiration": null,
            "visibilite": ""
        }
    }
}

REPONSE CORRECTE	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee23216e3743", "api": "tablomail.categories", "version": "", "data": { "pannes": { "nom": "pannes", "expiration": "90", "visibilite": "tous" } } }

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee2049587a49", "api": "tablomail.categories", "version": "", "data": { "status": false, "code": "404", "parametre": "nom_categori", "message": "PLG_API_NOM_CATEGORIES_NOT_FOUND" } }	Le paramètre saisi n'est pas celui attendu

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee2050f40e26", "api": "tablomail.categories", "version": "", "data": { "status": false, "nom": "", "code": "404", "message": "PLG_API_CATEGORY_EMPTY" } }	Le paramètre 'nom_categorie' est saisi, il doit avoir une valeur

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee2069b12179", "api": "tablomail.categories", "version": "", "data": { "status": false, "nom": "panne", "code": "404", "message": "PLG_API_CATEGORY_NOT_FOUND" } }	La catégorie demandée n'a pas été trouvée

Messages

Les messages sont généralement envoyés aux interlocuteurs par email. Il est possible d'y accéder par les web API

Demande

Méthode	URL	Paramètre URL	Paramètre Body (JSON)	Description
DELETE	/api-rest/tablomail/messages/	id_message		Suppression d'un message

exemples:

https://{server}/api-rest/tablomail/messages?id_message={id_message}

Contenu body:

Réponses

REPONSE CORRECTE

Description

{
    "err_msg": "",
    "err_code": "",
    "response_id": "5ee3904f800e9",
    "api": "tablomail.messages",
    "version": "",
    "data": {
        "status": true,
        "code": "200",
        "id_message": "5133",
        "nom_interlocuteur": "Copropriété de résidence De la Tour du Pin et du Grand Lyon de la France du grand Est",
        "email_interlocuteur": "Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.",
        "date_suppression": "2020-06-12 14:25:19",
        "message": "PLG_API_MESSAGES_DELETE_SUCCESSFULL"
    }
}

Remarques: les dates sont enregistrées en UTC dans la base de données

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee38b5466cc4", "api": "tablomail.messages", "version": "", "data": { "status": false, "code": "403", "parametre": "id_messag", "message": "PLG_API_IDMESSAGE_MISSING" } }	Le paramètre 'id_message' n'a pas été trouvé dans l'URL de la requête

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee38ee13ede4", "api": "tablomail.messages", "version": "", "data": { "status": false, "code": "404", "id_message": "a", "message": "PLG_API_MESSAGE_NOT_FOUND" } }	Message non trouvé

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee39110305b9", "api": "tablomail.messages", "version": "", "data": { "status": false, "code": "404", "id_message": "5133", "message": "PLG_API_INTERLOCUTEUR_MESSAGE_NOT_FOUND" } }	L'interlocuteur associé au message n'a pas été trouvé

ERREUR

Description

{
    "err_msg": "",
    "err_code": "",
    "response_id": "5ee3949fd7f25",
    "api": "tablomail.messages",
    "version": "",
    "data": {
        "status": false,
        "code": "500",
        "id_message": "5133",
        "nom_interlocuteur": "Copropriété de résidence De la Tour du Pin et du Grand Lyon de la France du grand Est",
        "email_interlocuteur": "Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.",
        "message": "PLG_API_MESSAGES_DELETE_BDD_ERROR"
    }
}

La suppression du message n'a pas pu être effectuée dans la base de donnée.

Contactez la maintenance en indiquant le détail de la requête effectuée

Demande

Méthode

URL

Paramètre URL

Paramètre Body (JSON)

Description

PUT

/api-rest/tablomail/messages/

id_message

titre (optionnel)

contenu (optionnel)

categorie (optionel)

Modification d'un message

Au moins un des paramètres optionnel doit être saisi

exemples:

https://{server}/api-rest/tablomail/messages?id_message={id_message}

Contenu body:

{"titre":"modifier titre6","contenu":"exemple contenu6","categorie":"informations"}

Réponses

REPONSE CORRECTE

Description

{
    "err_msg": "",
    "err_code": "",
    "response_id": "5ee3c6596aa9a",
    "api": "tablomail.messages",
    "version": "",
    "data": {
        "status": true,
        "code": "200",
        "id_message": "5133",
        "id_interlocuteur": "3",
        "nom_interlocuteur": "Copropriété de résidence De la Tour du Pin et du Grand Lyon de la France du grand Est",
        "email_interlocuteur": "Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.",
        "date": "2020-06-12 18:15:53",
        "expediteur": "Nicolas Wojtowicz",
        "titre": "modifier titre7",
        "contenu": "exemple contenu7",
        "categorie": "informations",
        "visibilite": "tous",
        "message": "PLG_API_MESSAGES_MODIFIED_SUCCESSFULLY"
    }
}

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee3a11e05f71", "api": "tablomail.messages", "version": "", "data": { "status": false, "code": "403", "parametre": "id_messag", "message": "PLG_API_IDMESSAGE_MISSING" } }	Le paramètre 'id_message' n'a pas été trouvé dans l'URL de la requête

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee3a1417bb03", "api": "tablomail.messages", "version": "", "data": { "status": false, "code": "404", "id_message": "a", "message": "PLG_API_MESSAGE_NOT_FOUND" } }	Message non trouvé

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee3a1d7f1ae2", "api": "tablomail.messages", "version": "", "data": { "status": false, "code": "404", "id_message": "5133", "message": "PLG_API_INTERLOCUTEUR_MESSAGE_NOT_FOUND" } }	L'interlocuteur associé au message n'a pas été trouvé

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee3b0432ff3c", "api": "tablomail.messages", "version": "", "data": { "status": false, "code": "403", "message": "PLG_API_PARAMETER_MISSING" } }	Aucun paramètre n'a été trouvé dans le body ( au moins un des paramètres doit être saisi)

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee3be7b1acd3", "api": "tablomail.messages", "version": "", "data": { "status": false, "code": "403", "categorie": "contrats", "visibilite": "conseil", "message": "PLG_API_BASIC_MODE_MUST_SPECIFIED_A_PUBLIC_CATEGORIE" } }	Si le serveur est en mode 'BASIQUE' seules les catégories à visibilité 'tous' sont permis

Demande

Méthode

URL

Paramètre URL

Paramètre Body (JSON)

Description

POST

/api-rest/tablomail/messages/

email_interlocuteur

titre ( et ne peut pas être vide)

contenu (peut être vide)

categorie (optionel)

AJOUT d'un message

exemples:

https://{server}/api-rest/tablomail/messages?email_interlocuteur={email_interlocuteur}

Contenu body:

{"titre":"titre7","contenu":"exemple contenu7","categorie":"informations"}

Réponses

REPONSE CORRECTE

Description

{
    "err_msg": "",
    "err_code": "",
    "response_id": "5ee3d50411fd9",
    "api": "tablomail.messages",
    "version": "",
    "data": {
        "status": true,
        "code": "200",
        "id_message": "5139",
        "email_interlocuteur": "Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.",
        "nom_interlocuteur": "Copropriété de résidence De la Tour du Pin et du Grand Lyon de la France du grand Est",
        "date": "2020-06-12 19:18:28",
        "expediteur": "Nicolas Wojtowicz",
        "titre": "exemple de titre",
        "contenu": "exemple de contenu",
        "categorie": "adefinir",
        "visibilite": "conseil",
        "message": "PLG_API_MESSAGES_ADD_SUCCESSFULLY"
    }
}

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee3d55b57bc6", "api": "tablomail.messages", "version": "", "data": { "status": false, "code": "403", "parametre": "email_interlocuteu", "message": "PLG_API_INTERLOCUTEUR_MISSING" } }	Le paramètre 'email_interlocuteur' n'a pas été trouvé dans l'URL de la requête

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee3d6099026c", "api": "tablomail.messages", "version": "", "data": { "status": false, "code": "404", "email": "Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.", "message": "PLG_API_INTERLOCUTEUR_NOT_FOUND" } }	L'interlocuteur demandé n'a pas été trouvé

ERREUR

Description

{
    "err_msg": "",
    "err_code": "",
    "response_id": "5ee3d854451e0",
    "api": "tablomail.messages",
    "version": "",
    "data": {
        "status": false,
        "code": "403",
        "email_interlocuteur": "Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.",
        "message": "PLG_API_INTERLOCUTEUR_MISSING_RIGHTS"
    }
}

L'utilisateur n'a pas les droits nécessaires pour réaliser la requête demandée

ERREUR

Description

{
    "err_msg": "",
    "err_code": "",
    "response_id": "5ee3d9393c8de",
    "api": "tablomail.messages",
    "version": "",
    "data": {
        "status": false,
        "code": "404",
        "parametre": "titre",
        "email_interlocuteur": "Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.",
        "message": "PLG_API_TITRE_NOT_FOUND"
    }
}

Le paramètre 'titre' n'a pas été trouvé dans le body

ERREUR

Description

{
    "err_msg": "",
    "err_code": "",
    "response_id": "5ee3d9bc88cac",
    "api": "tablomail.messages",
    "version": "",
    "data": {
        "status": false,
        "code": "403",
        "titre": "    ",
        "email_interlocuteur": "Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.",
        "message": "PLG_API_TITRE_EMPTY"
    }
}

Le paramètre 'titre' ne peut pas être vide

ERREUR

Description

{
    "err_msg": "",
    "err_code": "",
    "response_id": "5ee3dcd1c02f2",
    "api": "tablomail.messages",
    "version": "",
    "data": {
        "status": false,
        "code": "403",
        "categorie": null,
        "email_interlocuteur": "Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.",
        "message": "PLG_API_MESSAGES_BASIC_MODE_MUST_SPECIFIED_A_PUBLIC_CATEGORIE"
    }
}

En version 'BASIQUE' une catégorie avec visibilité 'tous' doit être spécifiée

ERREUR

Description

{
    "err_msg": "",
    "err_code": "",
    "response_id": "5ee3ddbea4881",
    "api": "tablomail.messages",
    "version": "",
    "data": {
        "status": false,
        "code": "404",
        "categorie": "blabla",
        "email_interlocuteur": "Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.",
        "message": "PLG_API_CATEGORIE_NOT_FOUND"
    }
}

La catégorie saisie n'a pas été trouvée

ERREUR

Description

La catégorie saisie n'a pas été trouvée

Demande A FINIR!!!!!

Méthode	URL	Paramètre URL	Paramètre Body (JSON)	Description
GET	/api-rest/tablomail/messages/			Récupération de tous les messages

exemples:

https://{server}/api-rest/tablomail/messages/

Contenu body:

Réponses

REPONSE CORRECTE

Description

{
    "err_msg": "",
    "err_code": "",
    "response_id": "5eecee921f141",
    "api": "tablomail.messages",
    "version": "",
    "data": [
        {
            "id_message": "5146",
            "date_modification": "2020-06-12 20:16:29",
            "email_expediteur": "API",
            "nom_expediteur": "Nicolas Wojtowicz",
            "categorie": "contrats",
            "commentaire": null,
            "id_interlocuteur": "3",
            "titre_message": "exemple de titre",
            "contenu_message": "exemple de contenu"
        },
        {
            "id_message": "5048",
            "date_modification": "2020-03-26 09:18:01",
            "email_expediteur": "Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.",
            "nom_expediteur": "Nicolas Wojtowicz",
            "categorie": "adefinir",
            "commentaire": null,
            "id_interlocuteur": "3",
            "titre_message": "test 20200326",
            "contenu_message": "<div class=\"yahoo-style-wrap\" style=\"font-family:verdana, helvetica, sans-serif;font-size:16px;\"><div dir=\"ltr\" data-setdir=\"false\">test<br></div></div>"
        }
    ]
}

Le contenu du message peut contenir des tags HTML

ERREUR	Description
{ "err_msg": "", "err_code": "", "response_id": "5ee3d55b57bc6", "api": "tablomail.messages", "version": "", "data": { "status": false, "code": "403", "parametre": "email_interlocuteu", "message": "PLG_API_INTERLOCUTEUR_MISSING" } }	Le paramètre 'email_interlocuteur' n'a pas été trouvé dans l'URL de la requête

Ajouter un Commentaire

JComments

Tablomail - Le tableau d'affichage virtuel qu'on met à jour par email!

Blog

API REST

Pré requis

Identification pour utiliser le web service

Format de la réponse

Erreurs globales à toutes les requêtes

Interlocuteurs ( tableaux virtuels)

Demande

Réponses

Catégories

Demande

Réponses

Réponses

Messages

Demande

Réponses

Demande

Réponses

Demande

Réponses

Demande A FINIR!!!!!

Réponses

Ajouter un Commentaire

Tags