Concepts clés
Retrouvez ici toutes les principales informations utiles.
-
Best Practices
Une synthèse des bonnes pratiques à appliquer pour l’utilisation dans vos applications de l’API Sage Business Cloud Comptabilité.
-
API : S’authentifier
l’API Sage Business Cloud Comptabilité est sécurisée par une authentification Oauth 2.0.
Suivez les étapes proposées pour implémenter l’authentification dans votre application. -
Consentements utilisateur
Chaque utilisateur d’une application utilisant l’API doit explicitement donner son consentement pour accorder le droit à l’application d’accéder à ses données.
-
OData : Paramètres et rôle
Des paramètres de requête OData facultatifs permettent de contrôler la quantité de données renvoyées dans une réponse.
-
OData : Règles
Quelques règles classiques de syntaxe d’utilisation de OData
-
OData : opérateurs
La liste des opérateurs OData pouvant être utilisés avec l’API Sage Business Cloud Comptabilité
-
OData : fonctions
La liste de toutes les fonctions OData pouvant être utilisés avec l’API Sage Business Cloud Comptabilité
-
OData : Propriétés de Navigation
Les propriétés de navigation permettent de définir les relations entre les différentes ressources.
Important de connaître ce concept notamment pour créer des ressources. -
OData : Pagination
La notion de pagination est fondamentale, il est important de savoir que l’API Sage Business Cloud Comptabilité renvoie à chaque demande un maximum de 100 enregistrements.
-
API : Codes de réponse HTTP
Dans Sage Business Cloud Comptabilité, chaque requête à l’API Sage Business Cloud Comptabilité va retourner un code de statut HTTP.
Ceci donne immédiatement une information sur le succès ou l’échec de la requête. -
API : Verbes HTTP
l’API Sage Business Cloud Comptabilité permet d’accéder en lecture et écriture aux données des bases Sage Business Cloud Comptabilité.
Ces accès s’effectuent par le biais d’appels de méthode HTTP s’appuyant sur des verbes.