Premiers pas

L’API est une interface permettant à des développeurs extérieurs d’interagir directement avec Sellsy sans utiliser l’interface web du service.

Il devient alors facile pour un développeur d’intégrer Sellsy à une application web ou de bureau.

Elle s’adresse aux entreprises qui souhaitent utiliser la solution mais qui n’ont pas besoin de l’ensemble des fonctionnalités ou qui souhaitent les utiliser dans un autre contexte. L’API Sellsy vous permet par exemple :

• De développer votre propre application mobile
• D’intégrer vos données Sellsy dans votre application métier (CRM, ERP, application propriétaire).
• D'utiliser Sellsy pour la facturation de votre site e-commerce.
• De synchroniser votre catalogue de produits/services
• De synchroniser vos contacts.

Pour l'utiliser, le développeur devra être familier avec les technologies conventionnelles du web (Oauth, PHP, Javascript, etc).

L’API Sellsy utilise des technologies conventionnelles et un connecteur PHP vous est fourni. Une application d’exemple est à votre disposition. Cette application vous présente l’ensemble des fonctionnalités de l’API et peut donc vous servir de base pour vos développements.

Sellsy ne prend pas en charge le développement de vos applications. En effet nos équipes se consacrent uniquement aux modules publics destinés à l’ensemble de la communauté Sellsy.

Si vous avez une idée de module pouvant intéresser de nombreux utilisateurs, n’hésitez pas à nous la soumettre.

L’API Sellsy est écrite en PHP, elle utilise OAuth en version 1.0. et 2.0.

- OAuth 1.0

Vous pouvez y accéder de deux manières :

• Via La classe Oauth native à php
• Via Curl

Nous vous fournissons ici deux classes de connexion à l'API Sellsy :

• SellsyConnect.php utilisant la classe Oauth native à PHP. Ce connecteur vous permettra de faire des applications publiques et privées.
• SellsyConnect_curl.php utilisant Curl. Ce connecteur ne vous permettra que de faire des applications privées.

Si votre application est Publique, nous utilisons Oauth avec une authentification de type third-party. Cela signifie que vous ne contrôlez pas l'identification de l'utilisateur. Celui-ci passe par une page de connexion qui est gérée par Sellsy.

Il vous est cependant possible d'éviter cette identification et de vous connecter directement. Dans ce cas, votre application sera Privée et elle ne pourra être utilisée que par votre compte Sellsy.

- OAuth 2.0

Avec la seconde version notre API, nous avons amélioré l'authentification en passant au protocole OAuth 2.0, pour unifier son application, nous avons rajouté la possibilité de se connecter à l'API Sellsy (1ère version) avec ce protocole.

La procédure de connection via OAuth 2.0 est détaillée sur la documentation de notre seconde version de l'API Sellsy

Avec l'API Sellsy nous avons implémenté un système de validation des applications. Elles peuvent être de deux types :

• Publique - Une application publique permet à n'importe quel utilisateur de se connecter à son compte via votre application. Ces applications utilisent une authentification de type third-party pour obtenir les tokens utilisateur. Autrement dit, si un utilisateur arrive sur votre application sans token, il sera alors redirigé vers notre page de connexion où il entrera ses identifiants et mot de passe. En contrepartie, l'application recevra un token/secret pour cet utilisateur qu'elle devra conserver afin de lui éviter de se reconnecter à chaque utilisation. C’est la solution idéale si vous souhaitez proposer un accès à votre application à l’ensemble des utilisateurs d’Sellsy.
• Privée - Par défaut les applications sont de type privée. Elle ne doivent pas passer par notre page d'authentification. Lorsque vous créez une application dans vos préférences Sellsy, vous recevrez votre token/secret unique d’utilisateur. Vous devrez le reporter dans le code de votre application et vous seul pourrez vous connecter via l'application. C’est la solution idéale si, par exemple, vous voulez ajouter une couche de facturation à votre site web.

Pour faire évoluer votre application de privée vers publique, il vous suffit de vous rendre dans votre compte Sellsy et de modifier les paramètres d'accès de votre application. Cette action lancera un processus de validation par nos équipes (généralement sous 24h).

Afin d'obtenir un accès a l'Api et de commencer à developper votre application, vous devez vous rendre dans les préférences de votre compte Sellsy. Vous trouverez la catégorie : 'Développeurs'.

Sur cette page vous pourrez administrer vos applications : création, modification, gestion des tokens et du niveau d'accès (publique/privée).

Il vous suffit donc de créer une nouvelle application. Vous obtiendrez vos tokens et pourrez commencer vos développements.

Vous avez maintenant une première approche de l'API, rendez-vous dans la documentation complète afin de commencer à développer votre application ou tester notre application de démo (sources disponibles).