Types de comptes et connexion aux APIs SWS
  • 03 Jul 2023
  • 3 Minutes à lire
  • Sombre
    Lumière
  • PDF

Types de comptes et connexion aux APIs SWS

  • Sombre
    Lumière
  • PDF

Résumé de l’article


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).

Fonctions utilisées dans les exemples

Pour simplifier la lisibilité, dans la suite de cette fiche nous prendrons dans les exemples :

  • SWS_ListeDossiers qui est disponible pour tous les types de compte
  • SWS_ListeUtilisateursDossierPaie qui est disponible uniquement pour les comptes API Client Option 2
  • SWS_LectureEffectifSociete qui est disponible uniquement pour les comptes API Éditeur

Cinématique de connexion


Pour pouvoir se connecter aux APIs SWS, il est nécessaire d'avoir 2 couples identifiant/mot de passe :

  • 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.

Paramètres de la fonction SWS_AppliquerDroitEditeur

Les paramètres de la fonction SWS_AppliquerDroitEditeur seront notés EDTLogin et EDTPwd pour simplifier la compréhension. Dans l'appel API à cette fonction, les paramètres sont Token, Login et Password.

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

API Client Option 1

sequenceDiagram_loginClientOption1

API Client Option 2

sequenceDiagram_loginClientOption2

API Client Option 1 + API Éditeur

sequenceDiagram_loginEditeur

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)

Exemples

Pour les exemples suivants, nous utiliserons les comptes suivants :

  • User1 : Compte utilisateur Silae qui a accès uniquement au dossier 0001, qui n'a pas les droits pour créer un utilisateur Contact.
  • User2 : Compte utilisateur Silae qui a accès uniquement au dossier 0002 et qui a les droits pour créer un utilisateur Contact.
  • Le compte API Client SWS (SWSLogin/SWSPwd) est un compte client Option 2.

sequenceDiagram_Droits Client

Fonctionnement avec un compte API Éditeur

Exemples

Pour les exemples suivants, nous utiliserons les comptes suivants :

  • Contact1 : Compte utilisateur Silae de type Contact qui a accès uniquement au dossier 0001 et qui n'a pas les droits pour contrôler les bulletins.
  • Contact2 : Compte utilisateur Silae de type Contact qui a accès uniquement au dossier 0002 et qui a les droits pour contrôler les bulletins.
  • Le compte API Client SWS (SWSLogin/SWSPwd) est un compte client Option 1.

sequenceDiagram_Droits Editeur


Cet article vous a-t-il été utile ?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.