Portail API déjà opérationnel

Introduction

La procédure qui suit s'adresser aux éditeurs partenaires API SIlae qui possèdent déjà son portail API et son environnement de test.

Si cela n'est pas le cas, veuillez suivre la procédure : Première connexion au portail API

Objectif : Le Client ID et le Client Secret ont été obtenu lors de la première connexion au portail API. Il reste à récupérer la nouvelle Clé de configuration d'accès API

L'environnement de test

Cette étape est facultative si le connecteur API REST a déjà été éprouvé et validé : L'environnement de production.

L'accès

...
Depuis le message reçu, suivre la procédure d'initialisation du mot de passe indiqué dans son contenu pour obtenir son accès.

La préparation et l'utilisation

1. Réclamer le ou les dossiers de paie Silae auprès du client sur lesquels vont être éprouvés et validés les développements API REST (le partenaire Silae devra exporter le ou les dossiers de paie du client depuis son l'environnement de production)
   
   
2. Accéder à l'environnement de test
   Domaine Silae Paie accessible de la même manière qu'un domaine de production, mais en utilisant l'url envoyée dans le mail reçu "Accès à votre espace collaborateur Silae"
   
   
3. Importer ces mêmes dossiers dans l'environnement de test (utiliser le mot de passe renseigné dans le mail reçu)

Base de connaissance Silae Paie : Exporter / Importer des dossiers de paie sur le logiciel

Les accès API REST

Le Client ID et le Client Secret

Le Client ID et le Client Secret ont été définis et copiés lors de la première connexion au portail API. Par conséquent aucune opération n'est à réaliser.

La configuration d'accès API

L'opération s'effectue depuis l'environnement de test.

1. Accéder à l'environnement de test
   
   
2. Utiliser la fonction Paramétrage Paie > bouton API
   

• Sélectionner le compte API de Test
• Désigner l’utilisateur Silae avec les droits d'accès nécessaires pour l'usage des fonctions API
  Base de connaissance Silae Paie : Créer et gérer un collaborateur, Droits d'accès clients, Définir les droits d'accès du contact client
• Choisir de l'accès aux dossiers de paie
  • Accès à tous les dossiers du domaine
  • Accès à un ou plusieurs dossiers : la sélection s'effectue par le bouton

La sauvegarde de la configuration API fait apparaitre le message suivant :

Dans le cadre de l'usage de l'environnement de test, aucune facturation ne sera générée.

La clé de configuration d'accès API

L'opération s'effectue depuis Mes Comptes de la page d'accueil du portail API.

1.Accéder au portail API

• Utiliser le bouton situé à droite du compte API de test désigné
  
• Sélectionner la fonction Modifier
  

2. Accéder à l'onglet Configuration d'accès API
   La configuration API définie précédemment apparait dans la liste
   

• Utiliser le bouton situé à droite du compte API de test désigné
  pour :
• • Activer la configuration d'accès API
  • Générer la clé principale ou secondaire (Subscription Key - Pas de différence entre la clé principale et secondaire). A conserver précieusement pour l'accès aux dossiers.

ID de Configuration d'accès API

Ne pas confondre :

• L'ID unique de configuration correspond à l'identifiant attribué lors sa création dans Silae Paie que l'on retrouve dans le compte API concerné au niveau du portail
• La clé de configuration d'accès API qui permet de donner accès aux données des dossiers de paie via API REST.

La mise en route des tests

1. Exploiter le Client ID et le Client Secret copiés pour s'authentifier (obtenir l'access_token avec la fonction API : Token Creation Prod)
   
   
2. Utiliser la Clé de la configuration d'accès API (Subscription Key) copiée pour obtenir les droits d'accès aux données des dossiers de paie désignés
   
   
3. Eprouver et valider les développements API REST

L'environnement de production

Les développements API REST ont été testés et validés.
La connexion peut être établie sur l'environnement de production

Les accès API REST

Le Client ID et le Client Secret

Le Client ID et le Client Secret ont été définis et copiés lors de la première connexion au portail API. Par conséquent aucune opération n'est à réaliser.

Si ce n'est pas le cas, effectuer la procédure qui suit.

Le Client ID et le Client Secret

L'opération s'effectue depuis Mes Comptes de la page d'accueil du portail API.

Le Compte API de Production apparait avec un statut "Attente d’activation"

1. Modifier le compte API de Test

• Utiliser le bouton situé à droite du compte API de test désigné
  
• Sélectionner la fonction Modifier
  

2. Le Client ID
   

Copier / coller le Client ID. A conserver précieusement pour l’authentification.


3. Activer le compte API

4.Le Client Secret
Accéder à l'onglet Gestion des ClientSecret

Cliquer sur le bouton

Copier / coller le Client Secret généré. A conserver précieusement pour l’authentification.

La configuration d'accès API

Les opérations qui suivent doivent être exécutées par le partenaire pour le compte du client qui souhaite mettre en place la connexion via les API REST avec la solution de l'éditeur.

Il est important de bien sélectionner le ou les dossiers de paie du client concerné par l'accès API REST.
La configuration API ainsi mis en place, le partenaire doit prévenir son client afin que l'éditeur puisse finaliser les opérations.

La clé de configuration d'accès API

L'opération s'effectue depuis Mes Comptes de la page d'accueil du portail API.

1.Accéder au portail API

• Utiliser le bouton situé à droite du compte API de test désigné
  
• Sélectionner la fonction Modifier
  

2. Accéder à l'onglet Configuration d'accès API
   La configuration API définie par le partenaire apparait dans la liste
   

• Utiliser le bouton situé à droite du compte API de test désigné
  pour :
• • Activer la configuration d'accès API
  • Générer la clé principale ou secondaire (Subscription Key - Pas de différence entre la clé principale et secondaire). A conserver précieusement pour l'accès aux dossiers.

ID de Configuration d'accès API

Ne pas confondre :

• L'ID unique de configuration correspond à l'identifiant attribué lors sa création dans Silae Paie que l'on retrouve dans le compte API concerné au niveau du portail
• La clé de configuration d'accès API qui permet de donner accès aux données des dossiers de paie via API REST.

La mise en route des API REST

1. Exploiter le Client ID et le Client Secret copiés pour s'authentifier (obtenir l'access_token avec la fonction API : Token Creation Prod)
   
   
2. Utiliser la Clé de la configuration d'accès API (Subscription Key) copiée pour obtenir les droits d'accès aux données des dossiers de paie désignés.