Concepts clés : Verbes Http
L’API Sage 100 permet d’accéder en lecture et écriture aux données des bases Sage 100. Ces accès s’effectuent par le biais d’appels de méthodes HTTP s’appuyant sur les verbes suivants :
Verbe | Description |
---|---|
Accède à une ressource (liste ou élément) ou appelle une fonction | |
Ajoute une ressource ou exécute une action | |
Met à jour une ressource complète en la remplaçant par une nouvelle version (nécessite de renseigner toutes les propriétés de la ressource) | |
Met à jour une partie d’une ressource en envoyant le différentiel (nécessite de renseigner uniquement les propriétés à modifier) | |
Supprime une ressource |
Différence PUT et PATCH
Il existe deux méthodes permettant de modifier des ressources, mais elles diffèrent grandement.
La principale différence entre les requêtes PUT
et PATCH
réside dans la façon dont le serveur traite l’entité pour modifier la ressource identifiée par la requête.
-
Dans une demande
PUT
, le contenu est considéré comme une version modifiée de la ressource stockée sur le serveur d’origine et le client demande que la version stockée soit remplacée. -
Avec
PATCH
, cependant, le contenu contient un ensemble d’instructions décrivant comment une ressource résidant actuellement sur le serveur d’origine doit être modifiée pour produire une nouvelle version.
En outre, une autre différence est que lorsque vous souhaitez mettre à jour une ressource avec une demande PUT
, vous devez envoyer le contenu de la ressource intégralement en tant que demande alors qu’avec PATCH
, vous n’envoyez que les valeurs que vous souhaitez modifier.
Exemple :
Supposons que nous ayons une ressource Client et que nous souhaitons modifier uniquement son SIRET.
Avec PUT
nous devons envoyer la totalité des valeurs des propriétés de la ressource client incluant la valeur de la propriété siret
, alors qu’avec PATCH
nous n’enverrons uniquement que la valeur de la propriété siret
modifiée.