api.sellsy

Utilisation de l'API

Vous trouverez ici l'ensemble des informations nécessaires à l'utilisation de l'API pour la création de votre application.

Urls d'accès

Afin de vous connecter à l'Api vous avez besoin de 2 éléments :

  • Vos tokens (ceux que vous avez reçu après la création de votre application)
  • Les Urls d'accès à l'Api :
    • Adresse de base : https://apifeed.sellsy.com/0/
    • Request token : https://apifeed.sellsy.com/0/request_token
    • Accès token : https://apifeed.sellsy.com/0/access_token

Avant de commencer

Nous vous invitons à aller lire la section 'Premiers Pas'. Vous devez ensuite créer votre première application dans les préférences de votre compte Sellsy. Veuillez bien noter le token/secret consumer ainsi que le token/utilisateur. Ils vous serviront lors de l'authentification à l'API.

Rendez-vous dans la section téléchargement afin de récupérer le code l'application de démonstration ainsi que les deux classes sellsyTools et sellsyConnect. (téléchargement)

Convention de nommage et de notation

Plusieurs termes spécifiques à OAuth sont utilisés dans cette documentation, voici leur signification :

  • OAuth - Désigne un protocole de sécurisation des échanges pour les API. Plus d'informations sur le site officiel (ici).
  • Consumer - Désigne l'application que vous allez développer.
  • Token - Désigne un identifiant unique d'utilisateur nécessaire pour l'identification OAuth. Il est représenté par un hash de 35 caractères.
  • Secret - Désigne la clé secrète qui permet de sécuriser les échanges via OAuth. Il est lui aussi représenté par un hash de 35 caractères.

Dans les exemples, les paramètres seront notés de la façon suivante :

  • {{param}}

Par exemple {{class}}.{{method}} aura pour valeur Client.getList.

Formatage des données

Pour utiliser l'API Sellsy, vous pouvez utiliser OAuth ou Curl, selon votre préférence et la configuration de votre serveur. Les données qui sont envoyées et reçues de l'API peuvent être formatées de deux façons :

  • JSON - Actuellement la seule méthode de formatage.
  • XML - Ce mode sera prochainement intégré.

Ce paramètre IO_MODE est spécifié lors des requêtes. Vous trouverez plus de détails dans la section Emettre et recevoir.

Discuter avec l'API

Afin de pouvoir discuter avec l'API vous aurez besoin de passer par 3 étapes :

  • L'Authentification
  • L'envoi et la réception de données
  • La gestion des erreurs

Nous vous fournissons les classes PHP vous permettant de réaliser ces 3 étapes. (téléchargement)

Il y'a en tout 3 classes :

  • sellsyTools : Classe outils.
  • sellsyConnect : La classe par defaut utilisant Oauth pour intéragir avec l'API. Elle permet de faire des applications privées et publiques.
  • sellsyConnect_curl : Classe utilisant Curl pour intéragir avec l'API. Elle permet de faire des applications privées.

A vous de choisir la classe la plus adaptée à vos besoins.