API REST : Connexion

api-hiboutik

 

1/ Présentation

L’API d’Hiboutik est une interface de programmation qui va vous permettre d’interagir avec votre logiciel de caisse à partir d’autres logiciels ou programmes informatiques externes.

Les principales opérations que vous pourrez effectuer seront de récupérer des données (ressources GET), d’ajouter des entrées (POST), de les mettre à jour (PUT) ou de les supprimer (DELETE).
Les réponses que vous recevrez sont au format JSON.

Un exemple pour mieux comprendre :
Vous disposez d’un site web géré sur une plateforme indépendante d’Hiboutik. Vous souhaitez que votre stock web soit partagé avec le stock de votre boutique physique. Il faut donc faire communiquer Hiboutik et votre plateforme web pour mettre à jour les stocks sur les deux solutions quand une vente est réalisée. Cette communication passe par les API.

 

2/ Authentification basique

Pour utiliser l’API de votre compte Hiboutik vous devez au préalable souscrire à l’option Premium.

Lorsque vous êtes connecté à votre compte, vous pouvez accéder d’un simple clic à la documentation et aux ressources (ou fonctions) de l’API en cliquant sur l’icône A en haut à droite de votre compte.

Pour communiquer avec l’API de votre compte, vous devez vous identifier.
Cette authentification peut se faire de manière basique avec un login (votre email) et un mot de passe (clef API).
Votre clef API est disponible dans la section « Paramètres/Utilisateurs/API » de votre compte.
Pour réinitialiser la clef API, allez dans « Paramètres/Utilisateurs/Utilisateurs » et cliquez sur l’icône clef en face de l’utilisateur.
Les opérations pouvant être effectuées via l’API sont limitées aux droits de l’utilisateur qui s’y connecte.

 

3/ Authentification Oauth2

L’accès à l’API peut également se faire via une authentification Oauth2. Ce mode de connexion est utilisé pour connecter directement des applications à votre compte.

Par cette méthode, l’accès à l’API est limité dans le temps (jeton avec une durée de validité) et dans les fonctionnalités (permissions accordées). Vous restez donc maître de ce que l’application peut voir et faire sur votre compte.

L’authentification Oauth2 est expliquée plus en détails dans la documentation de l’API.

le hibou a écrit 81 articles