API

Nos APIs

Vous trouverez dans cette section la description de nos APIs au format REST. Si vous utilisiez nos WebServices SOAP, les points API decrit dans cette partie de l'aide remplacent les méthodes que vous utilisiez.

Nos différentes APIs

Elles sont regroupées en trois grandes parties, en fonction de leur destination et/ou de leur contexte d'utilisation :

  • les API Principales permettent de connecter une application métier à l'intégralité de notre plateforme et sont à privilégier dans le cadre d'une application complexe, modifiant directement les données de votre entreprise
  • Les API e-commerce sont exclusivement disponibles dans un site e-commerce et permettent d'interagir avec le catalogue de ce dernier ainsi qu'avec tous les process de commande
  • Les API Phygitales sont destinées aux devices d'aides à la ventes : elles sont par exemple utilisée dans nos tablettes vendeurs, outils d'aides à la ventes, etc.

Il est à noter que le niveau de sécurité de l'api e-commerce est très réduit.

Conventions d'appels

Les APIs suivent les principes habituels des services REST : chaque opération est réalisée via un appel HTTP/HTTPS à une url donnée, éventuellement complétée de paramètres ou d'un corps de requête. Lorsqu'un corps de requete est demandé, celui-ci devra être passé au format JSON, avec un ContentType "application/json".

Les données passées en tant que paramètres d'url doivent suivre les conventions suivantes :

  • Les valeurs numériques seront présentées sans séparateur de regroupement et, dans le cas de valeur décimales, en utilisant le point . (ascii 0x2E) comme séparateur décimal
  • Les valeurs dates seront formatées selon la RFC 3339 et exprimées en UTC (par exemple 2010-01-01T00:00:01Z représente le 1er Janvier 2010 à minuit et 1 seconde UTC.
  • Les valeurs booléennes peuvent être passées sous la forme de true/false

Exemple d'appel

Obtenir les détails d'un article depuis les APIs principales :

En savoir plus