Principes communs

Les principes suivants s'appliquent à toutes les API Cegid Expert.
Ces principes sont conçus pour garantir la cohérence, la sécurité et la facilité d'utilisation des API.

Echanges de données via JSON

Toutes les API Cegid Expert utilisent le format JSON (JavaScript Object Notation) pour l'échange de données.

JSON est un format léger, facile à lire et à écrire pour les humains, et facile à analyser et à générer pour les machines.

Voir le détail

Constantes numériques

Les constantes numériques sont des valeurs fixes qui représentent une donnée.

Elles sont utilisées à la place des constantes chaînes pour éviter les erreurs de saisie ou de casse.

Voir le détail

Pagination

La majorité des API de lecture sont susceptibles de retourner un grand nombre de résultats.

Dans une optique de performance et de limitation de charge, ces API imposent la pagination.

Voir le détail

Filtres

Les filtres permettent de soumettre des critères de recherche lors de l'utilisation des API de lecture.

Cela limite le nombre d'enregistrements pouvant être retournés et diminue la charge.

Voir le détail

Sélection

Certaines API de lecture permettent de sélectionner les propriétés à retourner dans les résultats.

Cela permet de réduire la taille des réponses et d'améliorer les performances.

Voir le détail

Mise à jour des données

Certaines API permettent la mise à jour des données via des méthodes dédiées.

Il est important de comprendre les principes de mise à jour pour éviter des erreurs ou des comportements inattendus.

Voir le détail