FAQ API

Lien à copier

Comment obtenir un token d’autorisation d’accès à l’API ?

l’API Sage Business Cloud est sécurisée par une authentification Oauth 2.0.

L’exemple d’obtention d’un token est expliqué :

Quels droits sont nécessaires pour appeler l’API ?

Pour avoir le droit d’appeler les API, l’utilisateur doit satisfaire aux conditions suivantes :

  • L’utilisateur existe dans la société
  • L’utilisateur doit être actif
  • L’utilisateur est Administrateur ou Utilisateur (être invité ne suffit pas)

Quand l’utilisateur est valide, les droits nécessaires de l’API sont validés par rapport aux droits de l’utilisateur dans l’application.

Quand utiliser Tiers plutôt que Client, Fournisseur ?

L’api propose une ressource Tiers qui autorise les types suivants :

Pourquoi utiliser plutôt la ressource Tiers plutôt que d’utiliser directement une des ressources Client , Fournisseur, Salarié ou Autre ?
Posez vous ces questions par rapport au besoin fonctionnel souhaité :

  • Aurais-je toujours besoin d’un seul type ? Si oui vous pouvez utiliser directement la ressource typée.
  • Devrais-je pouvoir par exemple ajouter un filtre : les Clients seuls, les Fournisseurs seuls ou tous les clients et Fournisseurs ? Si oui il vous faudra utiliser la ressource Tiers sinon vous ne pourrez pas simplement appliquer ce type de filtre.
  • Mon code sera commun pour afficher la ressource client et la ressource fournisseur bien que l’interface propose deux accès distincts. Dans ce cas il sera aussi préférable d’utiliser la ressource Tiers et passer en paramètre le type souhaité.

Comment affecter des propriétés de type single-valued navigation ?

Ces propriétés sont en lien uniques avec une ressource et nécessitent un processus adapté.

Référez-vous à cette page : Concepts clés / OData - Propriétés de Navigation

Quand filtrer avec l’id client plutôt qu’avec le numéro client ?

La règle est simple :

  • Vous utilisez l’id du client quand c’est un paramètre de la ressource.
    Par exemple : récupérer les conditions de règlement du client DUPONT : clients('{clientId}')/reglements .
  • Vous utilisez le numéro du client quand le filtre est défini dans un $filter.
    Par exemple : Les écritures du client DUPONT : $filter :tiers/numero eq 'CARAT'

Bien évidemment cette règle s’applique aussi à tous les types de tiers et aux autres ressources identifiables par leur id et leur numéro ou code ou référence uniques.