API Connect utilise le concept d’application. Attachée à une organisation disposant d’un contrat Sis ID, une application représente un contexte d’utilisation des APIs dans le cadre de Sis Inside.
Une application comprend également :
-
Méthodes d’authentification et identifiants;
-
Abonnement à un plan associé à une limitation de débit.
Il est obligatoire de créer une application pour lancer des appels vers les APIs Sis Inside. Les applications peuvent être utilisées pour distinguer les contextes d’utilisation des APIs, l’origine des intégrations ou les sous-entités au sein d’une organisation cliente.
Création d’applications dans API Connect
Pour commencer à utiliser les APIs Sis Inside, vous devez créer au moins une application. Accédez à la section "Apps" et créez votre première application. Choisissez un nom d'application explicite, par exemple « Nom ERP Version X » ou « Nom du client pour ce cas d’usage ».
Note : Il est essentiel de bien récupérer et de stocker vos identifiants en toute sécurité, car le secret n’est fourni qu’une seule fois.
Souscription à un plan
Un abonnement à un plan est obligatoire pour utiliser les APIs. Sélectionnez :
-
Discovery plan pour un accès immédiat et un objectif de discovery;
-
Standard plan pour des conditions proches de la production et un usage normal. Un délai d’approbation pouvant aller jusqu’à un jour s’applique.
Vous pouvez désormais utiliser les APIs Sis Inside. Consultez la documentation des APIs pour savoir quelles APIs utiliser depuis la section "API Products".
Gestion des applications dans API Connect
Une fois créée, une application peut être gérée avec les options suivantes :
-
Modifier le nom de l’application depuis la page application, menu en haut à droite;
-
Vérifier le secret API, générer de nouveaux identifiants ou secrets API, changer le plan d’abonnement depuis l’onglet "Subscription";
-
Accéder aux métriques d’utilisation depuis l’onglet "Dashboard";
-
Consulter l’activité depuis l’onglet "Notification".