Portail API déjà opérationnel

Introduction

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

Il est important d'attendre de recevoir le message précisant que les comptes API ont été définis sur le portail API évoqué dans le chapitre Introduction - Envoi du message : comptes API prêts pour mettre en route les accès API REST.

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

Une nouvelle demande d'ouverture de comptes API a été formulée et les accès API REST doivent être mis en place.

L'environnement de test

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

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

Le Client ID et le Client Secret

Les opérations qui suivent, sont à réaliser uniquement s'il s'agit d'un nouveau compte API (non effectué lors de la première connexion au portail API) sur lequel le Client ID et le Client Secret doivent être récupérés (ex: CABINET FRANCE - CLIENT X pour une nouvelle demande d'ouverture de comptes API Modèle 2).

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

Le Compte API de Test concerné 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 concerné
• 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.

Tutoriel en images :

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, le Partenaire Silae doit transmettre 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.

Les accès API REST

Les opérations qui suivent, sont à réaliser uniquement s'il s'agit d'un nouveau compte API (non effectué lors de la première connexion au portail API) sur lequel le Client ID et le Client Secret doivent être récupérés (ex: CABINET FRANCE - CLIENT X pour une nouvelle demande d'ouverture de comptes API Modèle 2).

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".
Si le compte API est déjà activé, il est inutile d'effectuer les étapes suivantes. Le Client ID et le Client Secret est déjà en votre possession.

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 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 du choix effectué sur les dossiers de paie.

Tutoriel en images :

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