Getting started

Introduction

Welcome !

Cegid exposes a set of APIs to partners and customers to integrate Cegid Loop with other solutions.

An API (Application Programming Interface) is a software solution that allows applications to communicate with each other and exchange services or data.

You can follow the steps described below in order to quickly onboard with our APIs.

Step 1: Get an APIKey

The usage of APIs is secured with an APIKey generated by the accounting practice administrator on CegidLife portal.

There are two kinds of APIKeys :

  • APIKey Standard (P04448): free, for the usage of standard APIs. Can be shared with partners to connect their solution.
  • APIKey Advanced (P04454): billable, for the usage of cabinet APIs. Should be used exclusively by the accounting practice.

The APIKey is composed of key + : + client secret.

  • The key is public and will be configured in the LoopHub of Cegid Loop.
  • The client secret is private and should be stored securely for privacy concerns. It is essential for authentication in the usage of APIs.

Step 2: Activate your APIKey in Cegid Loop

To be activated in Cegid Loop, the APIKey must be set in the LoopHub of the accounting practice by an administrator.

Settings in LoopHub, documentation in French : https://assistanceloop.blob.core.windows.net/documentation/Gestion_interne/collaboratif_catalogue_applications.pdf

NB: For testing purposes, Cegid provides to partners access to CEGIDPARTENAIRES environment.

Step 3: Start trying out our APIs on Cegid Developers portal

Cegid Developers portal gives you a first experience with our APIs, with a complete description and documentation of all APIs.

To try out our APIs, two elements are required :

  • Fill in the "Authorization" part with your subscription key. Please contact your Cegid referent to get your subscription key.
  • Add a x-apikey header and fill it with your APIKey (key+:+client secret)

Then fill in the parameters and the request body before submitting tour request.

Step 4: Start your implementation

Once you've tried out the APIs and know how to use them, you can now start your implementation.

Note: A reliable implementation of API calls should include a retry policy, since some APIs may sometimes be unavailable.