Glossaire

Sommaire

Compte Portail API
Portail API
Société
Compte API
ClientID
ClientSecret
Clé de configuration d'accès API
Configuration d'accès API
Domaine

Définitions

Compte Portail API

C'est le compte qui permet de se connecter au Portail API. L'authentification se fait à partir de l'adresse mail donnée à Silae au moment de la contractualisation (login) et le mot de passe renseigné à la création du compte (suite à la réception du mail d'invitation). Ce compte est rattaché à un Compte API, mais il ne permet pas de se connecter aux API.

Portail API

Portail Web qui permet, pour les partenaires ou éditeurs qui possède un Compte API, de le gérer.
Il permet de :

• Visualiser les informations générales du compte et d'en modifier certaines
• Visualiser les Configurations d'accès API octroyées à ce compte API et de les activer/désactiver
• Gérer les secrets du Compte API et les clés des configurations d'accès API.

Société

Concept qui permet de faire le lien entre plusieurs comptes utilisateurs et plusieurs comptes API. Les comptes utilisateurs et les comptes API sont rattachés à des Sociétés. Dans la gestion de la société il est possible de configurer quels utilisateurs ont accès à quels comptes API.

Compte API

C'est le compte qui permet à votre logiciel de s'authentifier pour pouvoir utiliser les API REST Silae Paie. Ce compte possède notamment un couple ClientID/ClientSecret qui sont nécessaires à l'authentification.

ClientID

Identifiant du Compte API. Nécessaire pour exploiter les API, lors de l'authentification du Compte API.

ClientSecret (principal et secondaire)

Couplé au ClientID, le ClientSecret (équivalent à un mot de passe du Compte API) permet de s'authentifier auprès du serveur d'authentification Silae.
Le compte API possède 2 ClientSecrets, un principal et un secondaire. Les 2 ont la même fonction et s'utilisent exactement de la même manière. Chaque ClientSecret a une date d'expiration, et c'est pour permettre la transition au niveau de votre application qu'il existe un ClientSecret principal et un secondaire.

Clé de configuration d'accès API (Principale et secondaire)

Elle permet d'identifier via quelle Configuration d'accès API, le Compte API souhaite interagir avec les dossiers.
La configuration d'accès API possède 2 clés, une principale et une secondaire. Les 2 ont la même fonction et s'utilisent exactement de la même manière. Il n'y a pas de date d'expiration pour ces clés, et c'est pour permettre la transition au niveau de votre application qu'il existe une clé principale et une secondaire.
Cette clé dont son nom technique est subscription-key, doit être utilisée lors des appels aux endpoints via le header Ocp-Apim-Subscription-Key.

Configuration d'accès API

Une configuration d'accès API correspond à un accès octroyé par un partenaire sur ou plusieurs de ses dossiers.
Cette configuration d'accès possède plusieurs caractéristiques importantes :

• Compte API : Le compte API à qui est rattachée la configuration d'accès
• Domaine : Le domaine auquel est rattachée la configuration d'accès
• Liste de dossiers : Liste des dossiers auxquels aura accès le compte API auquel est rattachée le configuration d'accès. Ça peut être 1 dossier, plusieurs dossiers ou tous les dossiers du domaine
• Utilisateur Silae : Compte utilisateur Silae utilisé pour déterminer les droits d'accès aux données des dossiers. Le compte API ne pourra pas faire plus par API que ce que peux faire le compte utilisateur Silae.
• Identifiant unique : Identifiant unique de la configuration d'accès API

La mise en place d'un configuration d'accès s'effectue directement depuis Silae.
Une configuration d'accès peut être déclarée active ou inactive depuis le Portail API.

Domaine

Il représente un espace de travail contenant ses Dossiers (dossier de paie d'une entreprise). Chaque partenaire Silae détient un Domaine auquel est rattaché son Compte API s'il en a un. En revanche les comptes API des éditeurs ne sont pas rattachés à un domaine.