Guide de démarrage

Introduction

Bienvenue dans le guide de démarrage API REST qui a pour but de fournir le mode opératoire pour la mise en route des API REST Silae.

Conditions :

• Le contrat a été signé et retourné à Silae.
• Le formulaire d'ouverture de comptes API REST a été complété et renvoyé.

Notices Formulaire

Des modes d'emploi sont à disposition pour aider à remplir les formulaires selon le modèle :

• Modèle 1A et/ou 1B à usage interne du partenaire : Notice Formulaire Modèle 1A et/ou 1B
• Modèle 2 pour l'usage du client du partenaire : Notice Formulaire Modèle 2
• Modèle 4 pour l'éditeur de comptabilité Partenaire API Silae : Notice Formulaire Modèle 4

Mise en route des accès API REST

2 situations peuvent se présenter pour la mise en route des accès API REST :

• Première connexion au portail API et à l'environnement de test
• L'accès au portail API et à l'environnement de test sont déjà opérationnels

Quel que soit la situation, la mise en route des accès API REST nécessite d'obtenir les 3 éléments indispensables suivants :

1. Le Client ID
2. Le Client Secret
3. La Clé de configuration d'accès API

Le Client ID et le Client Secret permet de s'authentifier auprès du serveur d'authentification API Silae : Authentification

La Clé de configuration d'accès API permet d'utiliser les fonctions API REST pour accéder aux données de la Paie Silae en fonction du périmètre fonctionnel du modèle : Configuration d'accès API

Première connexion au portail API

Préparation

Dès la réception du premier formulaire, les équipes Silae procèdent à la préparation des éléments utiles pour la mise en route des API REST (un délai de quelques semaines est nécessaire pour une première demande) :

1. Mise en place du Portail API avec sa fiche Société et ses comptes API
2. Agencement d'un Environnement de test

Réception des messages

Lorsque les équipes Silae ont finalisé la mise en place du Portail API et de l'environnement, 3 messages sont envoyés.

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

Accès à l'environnement de test

Dès que l'environnement de test est prêt, un message est envoyé à l'adresse Email Utilisateur de l'environnement de test renseigné dans le formulaire.

Il suffit de suivre la procédure.

Accès au portail API

Dès que le portail API est prêt, un message est envoyé à l'adresse Email Utilisateur du portail API signalé dans le formulaire.

Il suffit de suivre la procédure.

Récapitulatif des éléments mis à disposition

Dès que tous les composants ont été mis en place, un message récapitulatif avec toutes les informations utiles est envoyé à l'adresse Email du demandeur déclaré dans le formulaire.

Ce message précise :
- L’URL de l'environnement de test mis à disposition
- Le mot de passe à utiliser pour importer le ou les dossiers de paie
- Les liens vers notre documentation et guide de démarrage

Portail API déjà opérationnel

Le portail API et l'environnement de test sont déjà actifs et une nouvelle demande d'ouverture de comptes API REST a été formulée.

Préparation

A la réception du nouveau formulaire, les équipes Silae procèdent à l'ajout des comptes API REST au portail API.

Envoi du message : comptes API prêts

Dès que les éléments sont prêts, un message est envoyé à l'adresse Email Utilisateur du portail API signalé dans le formulaire. Son contenu diffère selon la demande d'ouverture de comptes API.

Exemples :

Demande d'ouverture de comptes API modèle 1A et 1B (usage interne)
"Pour donner suite à votre demande d'ouverture de compte API REST, les comptes API suivants ont ajoutés sur votre portail API :

• TEST - NOM du PARTENAIRE
• NOM du PARTENAIRE - 1A
• NOM du PARTENAIRE - 1B

Demande d'ouverture de comptes API modèle 2 (usage client du partenaire)
"Pour donner suite à votre demande d'ouverture de compte API REST, les comptes API suivants ont ajoutés sur votre portail API :

• TEST - NOM du PARTENAIRE - NOM DU CLIENT
• NOM du PARTENAIRE - NOM DU CLIENT

Mise en route des accès API REST

Selon votre profil et votre situation, choisir le mode opératoire correspondant :

Connexion avec une solution éditeur partenaire API Silae

Besoin de connecter Silae Paie à une solution éditeur partenaire API Silae : Quels sont les éditeurs qui sont partenaires API Silae ?, il suffit de suivre la procédure : Comment donner les accès API à un éditeur partenaire API Silae ?