API pour développeurs

L'API permet aux développeurs de récupérer ou de modifier les données des différents outils de l'application Jestyc à partir d'autres applications (sites Internet, applications Excel, applications mobiles, logiciels divers, etc).

L'API permet par exemple de :

rechercher des données dans un outil et les afficher dans une autre application
enregistrer des données dans un outil à partir d'une autre application (par exemple un formulaire d'un site Internet)
etc.

Lorsqu'un utilisateur se sert de l'API, il dispose des mêmes droits d'accès que s'il utilisait directement l'application Jestyc.

Connexion à l'API

La première étape pour utiliser l'API est de récupérer un token en envoyant votre nom d'utilisateur et votre mot de passe.

Le token généré remplacera ensuite vos identifiants de connexion dans toutes vos prochaines requêtes (il reste valable tant que vos identifiants n'auront pas servi à générer un nouveau token ou à se connecter à l'application Jestyc).

Pour obtenir le token, copiez les données suivantes (au format JSON) et remplacez NOM_UTILISATEUR et MOT_DE_PASSE :

{
    "p": {
        "login": "NOM_UTILISATEUR",
        "password": "MOT_DE_PASSE"
    }
}

Envoyez ensuite ces données en POST à :

https://api.jestyc.com/v1/Login

Vous obtiendrez ensuite une réponse au format JSON avec votre token ainsi que votre ID d'utilisateur (ou un code d'erreur si les identifiants sont incorrects) :

{
    "token": "d80a06da51ace5bf353e3394cba57dae10a97edd8836c384003e4187bec4385e41",
    "user_id": "345"
}

Pour vous permettre de tester en temps réel une requête, un utilitaire de test est à votre disposition.

Liste des outils

La seconde étape consiste à récupérer la liste des outils auxquels vous avez accès et leurs ID respectifs.

Envoyez la requête suivante (avec le token récupéré à la première étape) :

{
    "p": {
        "token": "TOKEN"
    }
}

https://api.jestyc.com/v1/ToolsAccess

Vous obtiendrez ensuite la liste des outils auxquels vous avez accès au format JSON :

[
    {
        "id": "115",
        "tool": "2",
        "name": "Carnet de contacts 1",
        "access": "2"
    },
    {
        "id": "114",
        "tool": "2",
        "name": "Carnet de contacts 2",
        "access": "1"
    },
    {
        "id": "111",
        "tool": "1",
        "name": "Exemple de notes 1",
        "access": "2"
    },
    {
        "id": "113",
        "tool": "1",
        "name": "Exemple de notes 2",
        "access": "2"
    }
]

Chaque tableau représente un outil auquel vous avez accès et contiennent les informations suivantes :

id	ID unique de l'outil (information requise pour toute requête ciblant un outil)
tool	Type d'outil (1 = Jestyc Notes / 2 = Jestyc Contacts / 3 = Jestyc Messagerie)
name	Nom de l'outil tel qu'il a été défini depuis votre compte
access	Accès de l'utilisateur (0 = aucun accès / 1 = accès en lecture seule / 2 = accès complet)

L'ID d'un outil ne change jamais, il est donc parfois suffisant de récupérer l'ID de l'outil qui vous intéresse une première fois à l'aide de l'utilitaire de test pour vous éviter de devoir ajouter cette requête à votre code (l'ID d'un outil peut également être obtenu depuis votre compte, notamment dans l'URL de modification d'un outil).

Requêtes sur un outil

Vous disposez maintenant d'un token et de la liste des ID des outils auxquels vous avez accès, vous pouvez donc effectuer des requêtes sur l'outil de votre choix.

Vous trouverez la liste des requêtes que vous pouvez exécuter sur chaque outil sur la page API outils.

Pour mieux comprendre comment utiliser l'API et envoyer des requêtes, consultez les exemples pratiques mis à disposition (disponibles en PHP et VBA).