Introduction
The setup of the Silae connection is split up in two parts:
- Non-technical setup: this is done together with your accountant, as they will have to reach out to Silae for you in order to get everything set up. This process can sometimes take from a few days up to a few weeks
- Actual setup: once everything is prepared, the actual set up is easy to do. This is where you generate your API credentials to then enter them into the connection flow. You also need your accountant for some of the steps here, but if you go through this together it should take 15 minutes at maximum
Non-technical setup
- Reach out to your accountant, letting them know that they would like to set up the Silae API integration.
- The accountant reaches out to Silae, requesting access to the Silae REST API (it's important that they request access to the REST and not the outdated SOAP API; read more here)
- They will either directly reach out to their Silae sales contact
- or alternatively get in touch with them via the contact form
- As access to the Silae API is paid (read more here), the accountant will either sign an appendix to their distribution contract that covers access to the REST API or sign the distribution contract
- The accountant has to provide the following details to Silae for finalizing the access:
- Company Name of your company
- Silae-subdomain in the format of https://<subdomain>.silae.fr
- Main user: Your email address or the email of one of your colleagues. This email will get an invite to the API portal later in the process
- Technical contact: Email address of you or a colleague that will receive all information concerning the API (can be the same as the main user)
- Main test user: Email address of you or a colleague that will be the main user for the Silae test domain (can be same as the main user)
- API usage model: Silae has different models for using their API. For this case, Model 2 (Modèle 2) is needed
- Once the contract is signed and the information is submitted, Silae will create an API account and send a login/confirmation email to the main user email-address that was shared before
Setup
Generate client ID and client secret
This step is done by the end-customer via the API Portal
- Log into the API portal under https://api-portal.silae.fr/
- Open the API accounts tab (Mes comptes API)
- Click on the three dots at the right of your API account and then on "Éditer"
-
Go to the tab "Gestion des ClientSecrets"
Copy the Client ID and store it somewhere safe, as it's later needed for the API connection -
Now, in the tile where it says "ClientSecret Principal", click on "Regénérer"
- The next step informs you that the client secret can only be seen once. If you lose it you have to invalidate the old one and create a new one
Click "Valider" to continue - Copy the client secret and store it somewhere safe, as it's later needed for the API connection
Create a new API access configuration
This step is done by the accountant via the Silae Client application
- Log into the Silae Client application
- At the top, go to API
- At the very right, click on "Créer une configuration"
-
Select the API account, the Silae user and the payroll folders that should be accessed via API
It is only possible to do the things via API that Silae user selected here is able to do. It's therefore important to take into account what rights they have
Activate the API access configuration
This step is done by the end-customer via the API Portal
- Log into the API portal under https://api-portal.silae.fr/
- Open the API accounts tab (Mes comptes API)
- Click on the three dots at the right of your API account and then on "Éditer"
-
Go to the tab "Configurations d'accés API"
Click on the three dots at the right of the API access configuration
Click "Activer" to activate it
Important note: Once you activate the API access configuration, the billing cycle will start. To learn more about the pricing structure of the integration, read more here - Lastly, click on the the three dots again and then on "Regénérer clé principale" to view the key of the API access configuration
Copy the API access key and store it somewhere safe, as it's later needed for the API connection
Create the connection
Once you have the client ID, client secret and API access configuration key you can put them into the connection modal to finish setting up the integration