api/général

Fonctionnement général

Notre API est une API REST, utilisant le protocole HTTP pour la communication.
http://linkiliz.com/webservice/api.php

L'API contrôlera en-tête et body pour s'assurer de la validité des données que vous envoyez.
Vous devez donc utiliser un client REST pour communiquer avec celle-ci.

L'authentification des requêtes se fait par authentification basic (user:password).
L'obtention de votre password ne peut se faire qu'auprès de nos services, par mail à maxime@linkiliz.com ou par téléphone : 07 81 14 62 68

Les requêtes fonctionnent sur le shéma méthode / ressource.
Les méthodes sont les méthodes de bases HTTP, à savoir GET, POST et PUT.
Le 1er paramètre est la ressource (produits, stock, client...), et est obligatoire.
Le 2e paramètre "id" est facultatif (selon requête) et permet de cibler un élément en particullier (ex: un produit spécifique).

Le résultat est toujours retourné au format JSON, sous forme de tableau (clé/valeur).
Exemple d'un retour:
tableau de réponse JSON
Utilisez le code de status de la réponse pour vérifier si notre serveur a bien traité la requête. status code réponse
Les erreurs sont également toujours accompagnées d'une explication dans le corps de la réponse, sous forme de tableau json.
exemple: {"erreur":"La ressource 'proddduit' n'est pas une ressource accessible"}


Si vous n'avez pas un status code de retour 200, vous pouvez considérer que votre requête n'a pas abouti.

Quelques exemples pour comprendre rapidement:


Pour récupérer tous les produits :
Faire une requête GET sur http://linkiliz.com/webservice/api.php/ressource=produits

Pour récupérer un produit :
Faire une requête GET sur http://linkiliz.com/webservice/api.php/ressource=produit?id=000015

Notez la différence entre "produits" qui retournera tous les produits (qui n'a donc pas besoin d'id), et "produit" qui ne retournera le résultat que d'un seul produit.

Pour ajouter un nouveau produit :
Faire une requête POST sur http://linkiliz.com/webservice/api.php/ressource=produit
Les données de l'insertion doivent se trouver dans le body, au même format que l'exemple juste au dessus (exemple d'un retour), au format json.

Informations utiles pour tester

Certains modules REST existent sur navigateurs, ils peuvent vous être utiles si vous souhaitez rapidement tester notre API, pour voir par exemple les réponses retournées.

Celui-ci sur Firefox
Celui-ci sur Chrome
Evidemment ces outils ne vous serviront qu'à tester, il vous faudra utiliser vos propres méthodes pour communiquer avec notre API par HTTP.

Nos services peuvent vous communiquer un compte test pour faire vos essais, sur simple demande.

En php:


Un exemple de connexion simple utilisant file_get_contents (voir 1er commentaire)
Un exemple de connexion avec une fonction utilisant cURL (voir 1er commentaire)
N'oubliez pas que les données doivent être envoyées en json. De même, la réponse sera toujours obtenue en json, utilisez json_decode pour la traiter.