FAQ (questions fréquentes)
A propos de l'API
- Qu'est-ce que l'API ?
L'API est une option pour les développeurs qui permet de récupérer, modifier ou supprimer des données des outils de Jestyc à partir d'autres applications, logiciels, sites Internet, scripts, etc.
Il s'agit d'une "passerelle sécurisée" permettant de faire le lien entre les données des outils Jestyc et des applications tierces.
Par exemple, si vous disposez d'un site Internet avec un formulaire pour enregistrer des inscriptions, l'API pourrait vous permettre de les enregistrer directement dans l'outil de gestion des contacts.
- Où trouver la documentation de l'API ?
La documentation est disponible à partir du lien Développeurs (en bas à droite de chaque page du site).
- Comment vérifier la validité de ma requête ?
Un utilitaire de test vous permet de tester vos requêtes en conditions réelles (autrement dit, si vous modifiez ou supprimez des données, ces données seront réellement modifiées ou supprimées).
- Comment tester l'API sans risque pour les données existantes ?
Pour tester sans risque l'API, ajoutez un nouvel outil à votre compte qui sera dédié aux tests de l'API (en définissant les droits d'accès par défaut du nouvel outil sur "Aucun accès").
Modifiez ensuite les droits d'accès de l'API pour lui pemettre d'accéder à cet outil.
- Faut-il un utilisateur différent pour l'API ?
Pour utiliser l'API, vous devez disposer d'un nom d'utilisateur et de son mot de passe (les droits de l'API seront ceux de l'utilisateur choisi).
Il n'est pas obligatoire de dédier l'un des utilisateurs de votre compte uniquement à l'API mais cela reste toutefois vivement recommandé dans la plupart des cas, notamment pour :
- éviter de déconnecter l'utilisateur principal à chaque requête de l'API
- pouvoir faire la distinction entre les modifications faites par l'utilisateur principal et celles faites par l'API
- attribuer si nécessaire des droits d'accès différents à l'API (par exemple, un accès à un outil de test, ou encore, un accès en lecture seule pour plus de sécurité si l'API n'est pas autorisée à modifier les données)