Types de comptes et connexion aux APIs SWS

Types de comptes

Pour utiliser les API Silae Web Sevices (SWS), il existe 2 types de comptes :

• API Client (Possibilité de choisir Option 1 ou Option 2)
• API Éditeur

Chaque type de compte a accès à des fonctions API différentes. Dans le contrat, les droits sont représentés par des groupes de fonctions (cf. Mapping des droits).

Les comptes API Client Option 1 sont destinés à être fournis aux éditeurs.
Les comptes API Client Option 2 sont destinés aux clients qui souhaitent utiliser activement les API.

Un compte API Client SWS étant rattaché à un domaine sur une plateforme spécifique, il ne peut pas être utilisé pour accéder à un autre domaine ou une autre plateforme.

Chaque compte API Éditeur SWS peut être utilisé sur l'ensemble des plateformes, la restriction des droits se faisant sur la base des comptes "API Client SWS" et "Utilisateur Silae" (cf. détail dans le chapitre Cinématique de connexion).

Cinématique de connexion

• Un compte API Client (SWSLogin et SWSPwd) : Communiqué par Silae après signature du contrat API Client.
• Un compte utilisateur Silae (USRLogin et USRPwd) : Compte d'un utilisateur Silae qui a les droits d'accès au(x) dossier(s) voulu(s).

Pour les éditeurs, un couple supplémentaire est nécessaire :

• Un compte API Éditeur (EDTLogin et EDTPwd) : Communiqué par Silae après signature du contrat API Éditeur.

Fonctions de connexion aux APIs

Comme indiqué précédemment, pour se connecter aux APIs SWS en tant que Client API, il est nécessaire d'utiliser 2 couples identifiant/mot de passe avec la fonction SWS_SiteLogin. Si les informations de connexion sont correctes, cette fonction renvoie un Token qui sera utilisé dans quasiment toutes les autres fonctions API.
Pour se connecter aux API SWS en tant qu'Éditeur API, une étape supplémentaire est nécessaire : appliquer les droits éditeurs en utilisant la fonction SWS_AppliquerDroitEditeur.

Le diagramme de séquence ci-dessous présente le fonctionnement en fonction des types de compte utilisés.

API Client Option 1

API Client Option 2

API Client Option 1 + API Éditeur

Types de droits

Comme vu plus haut, l'appel à la fonction SWS_SiteLogin nécessite 2 couples identifiant/mot de passe pour pouvoir contrôler les droits à 2 niveaux lors des appels API :

• Le premier niveau de droit, lié aux identifiants de connexion API (Compte API Client - SWSLogin/SWSPwd - ou Compte API Éditeur - EDTLogin/EDTPwd - si les droits Éditeur ont été appliqués), permet de déterminer si l'appelant a le droit d'exécuter la fonction API.
• Le second niveau de droit, lié aux identifiants de connexion de l'utilisateur Silae (USRLogin/USRPwd) permet de déterminer si la fonction API peut accéder et/ou manipuler les données du domaine ou dossier concerné, en se basant sur les droits de l'utilisateur Silae. Dans tous les cas, il ne sera pas possible de faire via API ce que l'utilisateur Silae ne peut pas faire dans l'application.

Fonctionnement avec un compte API Client (Option 2)

Fonctionnement avec un compte API Éditeur