Première connexion au portail API

Introduction

La procédure qui suit s'adresser aux partenaires qui accèdent pour la première fois à leur portail API et et à leur environnement de test.

Il est important d'attendre la Réception de tous les messages pour mettre en route les accès API REST.

Elle se découpe en 3 parties :

1. Le portail API : Son accès, son contenu
2. La préparation de l'environnement de test et la mise en route des accès API REST
3. La mise en route des accès API REST sur environnement de production

Objectif : Obtenir les 3 données obligatoires pour le bon fonctionnement des API REST Silae :

• Le Client ID
• Le Client Secret
• La Clé de configuration d'accès API

Le portail API

L'accès

Suite à la réception du message d'accès au Portail API, il est nécessaire de suivre les étapes suivantes :

1. Cliquer sur le lien Accéder au portail API contenu dans le mail reçu.

   

Message d'erreur lors du premier accès

Le message suivant apparaît :" A user with the specified credential could not be found.", cela signifie que votre lien d'invitation a expiré.
Il est nécessaire de solliciter notre équipe Support API avec la saisie du formulaire Assistance (thème API) disponible depuis Silae Paie ou par l'envoi d'un message à l’adresse suivante : support.api@silae.fr pour obtenir un nouveau message d'accès au Portail API.

2. Renseigner nom, prénom et le mot de passe souhaité.
   

3. Se connecter au Portail API
   

A ajouter aux favoris du navigateur.

Tutoriels en images :

• Premier accès :

• Lien Portail API et accès page accueil :

Le contenu

Ma société

La fiche Société propose 3 onglets :

• Les Informations générales qui permet de modifier l'email du contact technique API renseigné selon la donnée indiquée dans le formulaire.
  
  
• La Liste des utilisateurs qui ont accès au portail API.
  
  De nouveaux utilisateurs peuvent être ajoutés pour leur donner accès au portail API. L'option Droit de gestion donne accès à la fiche Société
  
  
  
• La Liste des comptes API mis en place (même fonction que Mes comptes API).
  

Mes comptes API

Selon le ou les formulaires remplis et validés, plusieurs comptes API REST sont mis à disposition.

Comptes API pour usage interne du partenaire (modèle 1A/1B)
Comptes API pour usage client du partenaire (modèle 2)

Les autres comptes API sont associés à l'environnement de production.

Tutoriel en images :

Documentation API Silae

Ce point d'entrée permet d'accéder directement à la documentation consultée actuellement.

Tutoriel en images :

L'environnement de test

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. Exporter le ou les dossiers de paie à utiliser pour effectuer les tests API REST depuis l'environnement de production
   
   
2. Accéder à l'environnement de test
   Domaine Silae 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

La procédure qui suit reste identique quel que soit le compte API de TEST à activer :

• Compte API pour usage interne Modèle 1A et/ou 1B (ex : TEST - CABINET FRANCE)
• Compte API pour l'usage du client Modèle 2 (ex: TEST - CABINET FRANCE - CLIENT SARL)

Les étapes suivantes doivent donc être répétées pour chaque compte API défini.

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

Tutoriel en images :

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 qui vient d'être activé.
• 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 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.

Tutoriel en images :
Depuis l'environnement de test

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.

Tutoriel en images :

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

Dans le cas où les développements doivent être éprouvés et validés par le prestataire/éditeur du client, son Partenaire Silae doit lui communiquer ces éléments indispensables : le Client ID, Client Secret et la Clé de la configuration d'accès API (ex: TEST - CABINET FRANCE - CLIENT SARL)

L'environnement de production

Les développements API REST ont été testés et validés.
La solution d'interconnexion avec Silae Paie peut être mis en place.
La procédure qui suit est identique à celle utilisée pour l'environnement de test.

Les accès API REST

La procédure qui suit reste identique quel que soit le compte API de PRODUCTION à activer :

• Compte API pour usage interne modèle 1A et/ou 1B (ex : CABINET FRANCE - 1A ou CABINET FRANCE - 1B)
• Compte API pour l'usage du client modèle 2 (ex: CABINET FRANCE - CLIENT SARL)

Le Client ID et le Client Secret

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

l

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.

Tutoriel en images :

La configuration d'accès API

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

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

• Sélectionner le compte API de Production qui vient d'être activé dans la liste
• 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 :

Il est important de bien sélectionner l'accès pour ne pas être facturé sur des dossiers de paie qui ne sont pas concernés par un usage API REST.

• Un compte API de production modèle 1A (ex : CABINET FRANCE - 1A) est inclus dans l'offre Silae Paie : aucune facturation ne sera générée.
  
• Un compte API de production modèle 1B (ex : CABINET FRANCE - 1B) ou modèle 2 (ex: CABINET FRANCE - CLIENT SARL) : une facturation sera générée en fonction des dossiers sélectionnés.

Tutoriel en images :
Depuis l'environnement de production

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.

Tutoriel en images :

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.

Dans le cas où les développements doivent être éprouvés et validés par le prestataire/éditeur du client, le Partenaire Silae doit communiquer à son client, ces éléments indispensables : le Client ID, Client Secret et la Clé de la configuration d'accès API (ex: TEST - CABINET FRANCE - CLIENT SARL)