Cette fonctionnalité est un module optionnel de IGFact. L’API vous permet de connecter per exemple un site Web à IGFact.
L’API permet de rendre les données de IGFact disponibles pour d’autres services également.
Paramétrage dans IGFact
Quand nous vous activons le module de l’API, vous recevrez un email qui vous permettra de définir votre mot de passe d’accès à l’API.
Ensuite vous aurez donc les deux paramètres vous permettant de configurer IGFact.
Un login (adresse email)
Un mot de passe
Pour activer le module, il faut aller dans le menu Utilitaires > Configuration > Paramètres de liaison avec IGFact API
Dans cet écran, indiquez juste votre login et votre mot de passe., puis validez sur le V vert.
Migration des données
Afin que vos données soient accessibles par un service externe, il faut les synchroniser dans le Cloud.
Pour cela, allez dans le menu Utilitaires > Fichiers > Exportation > Exportation IGFact Web
Cette étape permet de vérifier la cohérence de vos données et de les envoyer dans le Cloud.
L’opération n’est à effectuer qu’une seule fois, car par la suite les données sont mises à jour en temps réel par IGFact.
Cochez bien la case “Vérifier la cohérence” avant de démarrer la procédure.
Documentation de l’API
Les développeurs de sites web ou de services externes peuvent consulter le swagger de l’API à l’adresse suivante:
https://igfact-ws.igsoft.eu/swagger/index.html
Contactez nous si vous souhaitez plus d’information à ce sujet.
Description de l’API
Chaque objet disponible dispose des mêmes méthodes génériques. Seules les méthodes en lecture sont disponibles au départ d’une application tierce.
A savoir :
/api/ObjectName/GetAll
Donne la liste complète des objets disponibles./api/ObjectName/GetPage
Donne la liste complète des objets disponibles par page de taille spécifique (maximum 100) et avec éventuellements des filtres appliqués ou un tri.Il est également possible de spécifier si l’on veut ou non avoir les traductions liées aux objets
/api/ObjectName/GetById/{id}
Donne l’objet défini par l’id fourni en paramètre dans l’URL/api/ObjectName/GetLatest/{from}
Donne la liste des objets modifiés depuis le timestamp UTC fourni dans l’url
L’API requiert une Authentification via un token d’API qui peut être récupéré via un objet propre à l’authentification, à savoir l’objet Token de l’API.
Le format des objets est décrit dans le bas de la page swagger :
Les valeurs énumérables sont également disponibles :
Authentification
Pour s’authentifier sur l’API en tant qu’application tierce, il faudra faire un POST sur
Méthode indépendante
https://igfact-ws.igsoft.eu/api/Token/LoginUser
Dans le body de la requête, il faudra fournir cet objet :
{
"Email": "votre@email.com",
"Password": "****",
"SerialNumber": "99999999999"
}
La réponse vous donnera le Token dont vous avez besoin pour utiliser l’API
Méthode dépendante
https://igfact-ws.igsoft.eu/api/Token/LoginExtenalLink
Dans le body de la requête, il faudra fournir cet objet :
{
"Email": "votre@email.com",
"Password": "****",
"SerialNumber": "99999999999"
}
La réponse vous donnera le Token dont vous avez besoin pour utiliser l’API
Avec pour Header :
Content-Type: application/json
X-Tenant-Guid : 99999999999
Et en Authorisation:
La réponse contiendra un objet json avec le token et sa validité UTC (DateExpire) pour appeler les différentes méthodes de l’API :
{
"Email": "votre@email.com",
"Password": "****",
"Token": "ey1JhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy933cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9lbWFpbGFkZHJlc3MiOiJqdWFuQGlnc29mdCZSIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eSTgzODU1MzY4LCJpc3MiOiJsb2NhbGhvc3Q6ODA2MCIsImF1ZCI6ImxvY2FsaG9zdDo4MDYwIn0.G2osnX84qEagswBkzjo96ChPke2_shKhcgaV2XlP7cc",
"SerialNumber": "99999999999",
"UserInstallModules": null,
"AppId": 6,
"AppPlateformeId": 1,
"LegacyId": 9,
"UserId": 128,
"DateExpire": "2020-03-10T16:49:28.818716+01:00"
}
Webhooks
Pour adapter les URLs des webhooks, et en consulter les notifications, vous pouvez vous rendre sur https://igfact.igsoft.eu. Vous loguer avec votre compte et votre SerialNumber sans cocher la case “Admin”.
Dans la section WebHook , vous pouvez adapter les URLs correspondant aux évènements Create, Update et Delete.
Vous pouvez consulter toutes les notifications émises dans la section Tracking WebHook Out
Vous pouvez également vérifier l'état des stocks des produits dans la section product (les images sont auto-généré et n'ont donc pas de rapport avec le produit).
Vous avez ainsi tous les outils nécessaires pour la mise en place et les mises à jour éventuelles d'url pour les notifications.