LWSDOCUMENTATION

WooSoftware

Bienvenue dans la documentation de WooSoftware, la solution de vente de logiciels et biens dématérialisés pour WooCommerce.

La documentation se découpe en plusieurs sections :

  1. Interface d'administration de WooSoftware
  2. Paramétrage des produits
  3. Utilisation de l'API et activation des licences

 

Interface d'Administration

Toutes nos extensions sont conçues avec une attention particulière portée à la simplicité d’utilisation. Dans la plupart des cas, les options disponibles, ainsi que leurs effets, sont expliquées directement dans l’interface d’utilisation.

Il peut cependant arriver que vous ayez des besoins spécifiques ou que certaines options disponibles soient moins compréhensibles. La section ci-dessous explique, point par point, les différentes options disponibles dans l'interface d'administration de WooSoftware.

Vous accédez à l'interface d'administration de WooSooftware depuis l'administration de votre site WordPress en cliquant dans le menu sur WooCommerce → WooSoftWare.

Paramètres → Fonctionnalités

Cette page est la première page de l'administration que vous devriez visiter. Elle vous permettra d'activer les différentes fonctionnalités de WooSoftware dont vous avez besoin.

1 – API

WooSoftware est fourni avec une API (Application Programming Interface) complète pour gérer tous les échanges entre les logiciels vendus et WooCommerce. Lorsque vous installez WooSoftware sur votre site, une url d'appel de l'API est automatiquement créée (que vous pourrez modifier dans la section Paramètres → API).

L'API doit être activée pour que les produits que vous vendez puissent-être activés ou mis à jour.

2 – Licences

Les licences permettent de protéger vos logiciels contre la copie. En activant les licences, la vente d'un logiciel ou bien dématérialisé génèrera une ou plusieurs clés de licence. Le client devra renseigner la licence dans sa copie du logiciel afin de pouvoir l'utiliser.

Attention, WooSoftware ne fournit pas de code pour la gestion des licences dans les logiciels que vous vendez !

WooSoftware génère les clés de licences et fournit des fonctions appelables dans l'API afin de permettre l'activation et le suivi des licences actives.

3 – Versions

La fonctionnalité 'Versions' vous permet de gérer plusieurs versions des logiciels que vous vendez. Vous pouvez ainsi proposer des mises à jour de vos solutions à vos clients, tout en gardant les anciennes versions disponibles en cas de besoin.

En outre, chaque version peut être catégorisée (par OS par exemple) en fonction de vos besoins afin de proposer plusieurs fichiers selon les catégories.

Enfin, l'ajout d'une date de sortie vous permettra de définir par avance la sortie de nouvelles versions.

4 – Maintenances

Les maintenances permettent de proposer une période de support/mise à jour pour vos produits. A chaque fois qu'une maintenance est sur le point de se terminer, les clients ont la possibilité d'acheter une nouvelle période.

Les maintenances ne peuvent pas être activées sans que les fonctionnalités de licences et de versions soient actives.

Activer les maintenances restreint automatiquement la possibilité de télécharger des nouvelles versions de vos produits aux clients possédant une maintenance active pour ces produits. Les clients pourront cependant toujours télécharger les versions plus anciennes auxquelles ils avaient initialement droit.

5 – Versions Lite/Full

Cette fonctionnalité vous permet de proposer à vos clients des versions gratuites et allégées de vos produits. La saisie des produits dans WooCommerce changera alors pour proposer un fichier pour la version allégée et un fichier pour la version complète.

La version complète ne sera disponible que par mise à jour de la version allégée en passant par un appel à l'API.

Les versions Lite/Full ne peuvent pas être activées sans que la fonctionnalité de licences soit active.

6 – Extensions WordPress

En activant cette fonctionnalité, vous activez de nouveaux paramètres dans la saisie de produits vous permettant de vendre des extensions WordPress.

Paramètres → API

L'utilisation de l'API est expliquée plus précisément dans la partie de la documentation qui lui est consacrée. Cependant, les principales URLs d'appel aux fonctionnalités de l'API sont données dans l'écran de paramétrage de l'API pour vous faciliter la vie.

1 - Options

Endpoint pour l'API : Cette option vous permet de simplifier l'url d'appel à l'API en y renseignant un terme qui vous est propre. Spécifier un Endpoint vous permettra d'avoir des adresses d'appel plus élégantes et personnalisées. Spécifier un Endpoint permettra de remplacer la partie "/wp-admin/admin-ajax.php?action=lwswoosoftware" par votre terme personnel.

Autoriser l'API à renvoyer des produits privés : De base, WooCommerce oblige les utilisateurs à être connectés pour afficher les produits privés. L'API WooSoftware respecte par défaut ce paramètre. Vous pouvez cependant décider de surcharger cette valeur.

Autoriser l'API à renvoyer des produits gratuits : Comme pour les produits privés, les produits gratuits n'ont pas vocation à être fournis par l'API (puisque ne nécessitant pas de clé de licence). Vous pouvez cependant décider de surcharger cette valeur.

Réponse sur mise à jour en cas de licence expirée : Lorsqu'une licence sur un produit a expiré, l'utilisateur du logiciel peut toujours envoyer des requêtes de mise à jour. Par défaut, l'API renverra une erreur "401 - Non Autorisé". Dans le cas où vous proposez des versions gratuites de vos produits, vous pouvez cependant décider de renvoyer la version gratuite de votre logiciel à la place de l'erreur.

Page Vitrine : En cas de besoin, vous pouvez renvoyer le contenu d'une page de votre site WordPress via un appel à l'API (pour des fins de publicité par exemple).

 

2 - Paramètres des versions

Lorsque vous saisissez des versions de vos logiciels, vous avez la possibilité de saisir des catégories en face des fichiers téléchargeables. Dans cette partie, vous pouvez ajouter ou supprimer des catégories (utile en cas de saisie erronée).

Paramètres → Emails

Dans WooSoftware, des emails sont envoyés aux clients lorsqu'ils ont des maintenances sur le point d'expirer. Les emails contenant les clés de licence sont envoyés par WooCommerce et ne peuvent donc pas être modifiés ici.

1 - Rappel

Ce paramètre vous permet de configurer le nombre de jours avant l'expiration d'une maintenance où l'email de rappel sera envoyé. Si aucune valeur n'est saisie, aucun email de rappel ne sera envoyé à vos clients.

2 - Paramètres des Emails

Dans cette partie, vous pouvez spécifier le logo qui apparaîtra dans l'entête de vos emails ainsi que le texte qui apparaîtra en enpied (code html et liens possibles)

3 - Renouveler la maintenance

Ces paramètres vous permettent de personnaliser le contenu et l'apparence de l'email envoyé à vos clients lorsqu'une de leurs maintenances est sur le point d'expirer.

  • Sujet : Sujet de l'email
  • Titre : Titre de l'email
  • Entête : Texte qui apparaît au dessus du détail des maintenances sur le point d'expirer (html et liens possibles)
  • Style : Grâce à notre outil stygen, vous pouvez personnaliser l'affichage et les couleurs des emails envoyés. Sélectionnez les éléments que vous souhaitez modifier et utiliser la barre de style supérieure pour modifier l'affichage.
  • Email destinataire : Vous pouvez tester l'affichage des emails en vous envoyant un email de test.

Licences → Licences actives

Cette partie vous permet de voir l'ensemble des licences qui ont été générées par WooSoftware depuis l'activation de la fonctionnalité "Licences". Un champ de recherche est à votre disposition pour vous permettre de trouver plus facilement une licence spécifique.

Pour chaque licence, vous disposez de plusieurs informations :

  • Utilisateur : L'identifiant de l'utilisateur qui possède la licence
  • Produit : Le produit pour lequel la licence a été générée
  • Expiration : La date d'expiration dans la licence si pertinent, "Pas activé" si la licence n'a jamais été activée ou "Illimitée" si activée sans date d'expiration ainsi que la date d'enregistrement de la licence si activée.
  • Clé de licence : La clé de licence qui a été générée.

Vous avez la possibilité de supprimer des licences directement dans la liste. Attention, supprimer une licence supprime aussi toute maintenance ou autres options qui lui seraient associées.

Enfin, si une licence a été activée, vous avez la possibilité de réinitialiser son empreinte afin de pouvoir procéder à une nouvelle activation.

Licences → Options

Une seule option est disponible pour les licences : le modèle des clés.

En effet, WooSoftware vous offre la possibilité de créer vous-même le modèle des clés de licence.

Les différentes possibilités sont expliquée directement en entête de la page. Attention, les clés doivent toujours posséder 20 caractères ou plus.

Maintenances → Maintenances en cours

Cette partie vous permet de voir l'ensemble des maintenances qui ont été générées par WooSoftware depuis l'activation de la fonctionnalité "Maintenances". Un champ de recherche est à votre disposition pour vous permettre de trouver plus facilement une maintenance spécifique.

Pour chaque maintenance, vous disposez de plusieurs informations :

  • Utilisateur : L'identifiant de l'utilisateur qui possède la licence
  • Produit : Le produit pour lequel la licence a été générée
  • État : état de la maintenance (Actif ou Non activé)
  • Expiration : La date d'expiration de la maintenance si Actif, la durée initiale offerte si Non activé
  • Clé de licence : La clé de licence qui a été générée.

Vous avez la possibilité de supprimer des maintenances directement dans la liste.

Vous pouvez aussi étendre les durées de maintenance des maintenances activés en cochant les cases correspondantes et en renseignant une nouvelle date d'expiration dans le champ correspondant.

Maintenances → Options

Les options des maintenances sont des paramètres généraux qui seront associés par défaut à tous les produits pour lesquelles la maintenance est activée.

Ces options peuvent être remplacés par des valeurs spécifiques pour chaque produit si besoin.

  • Pourcentage de prix par défaut (%) : Pourcentage du prix du produit utilisé comme base de calcul du prix de la maintenance.
  • Durée de vie par défaut : Période de maintenance offerte par défaut lors de l'achat d'un produit.
  • Période de renouvellement minimum : Un client ne peut pas demander un renouvellement de maintenance d'une période inférieure à cette valeur.
  • Prix de renouvellement minimum : Un client ne peut pas demander un renouvellement de maintenance d'un montant inférieur à cette valeur.
  • Précision de l'arrondi : Arrondi du prix de renouvellement de maintenance.

Paramétrage des produits

WooSoftware ajoute de nombreux éléments à la saisie de produits WooCommerce selon les fonctionnalités que vous activez. Pour chaque produit, vous pouvez utiliser une ou plusieurs des possibilités offertes par WooSoftware.

Les fonctionnalités ne sont disponibles dans la saisie de produit que pour les Produits simples avec les cases Virtuel et Téléchargeable cochées.

Une fois que WooSoftware est activé, la saisie de produit simple est modifiée et quelques champs sont ajoutés :

  • ID d'API du produit : L'identifiant du logiciel vendu pour l'API. Cet identifiant doit être codé dans le logiciel que vous vendez et sera envoyé lors de chaque échange entre le logiciel et l'API.
  • Localisation : Langue du produit. Dans le cas où vous vendez le même produit dans plusieurs langues, vous devrez créer plusieurs copies du produit.
  • Langue par défaut : Définit s'il s'agit de la langue principale du produit.

Licences

Lorsque vous cochez la case Licence dans la saisie de produit, un nouvel onglet apparaît. Rendez-vous dans cet onglet pour saisir les valeurs spécifiques à ce produit :

  • Clé secrète : Il s'agit d'un hachage spécifique à votre produit, destiné à renforcer la sécurité lors de son activation. Cette valeur est optionnelle et ne doit être utilisée que si votre logiciel en a l'usage.
  • Nombre de licences : Indique le nombre de licences qui sont générées lors de l'achat de ce produit.
  • Durée de vie de la licence : Nombre de jours de validité de la licence. Laissez vide si la licence n'expire pas. Cette valeur peut être utile pour des produits avec période d'essai.
  • Achat unique : Définit si le produit ne peut être acheté qu'une seule fois par client (utile aussi en cas de période d'essai)
  • Préfixe de la clé : Si vous désirez une clé d'activation spécifique pour votre produit, vous pouvez ici spécifier un préfixe qui sera placé devant chaque clé de licence générée.

Versions

Lorsque vous cochez la case Versions dans la saisie de produit, la saisie des fichiers est modifiée pour permettre la saisie de versions.

Le bouton Ajouter une version permet d'insérer un nouveau bloc de saisie de versions à la liste des versions déjà saisies.

Pour chaque version, il faut ensuite saisir les champs suivants :

  • Numéro de version : Numéro de version de votre logiciel (par exemple 2.4.3)
  • Date de sortie : Date de sortie de la version. Peut être définie dans le futur pour la masquer jusqu'à la date définie.
  • Fichiers : Il est possible de spécifier plusieurs fichiers en cliquant sur Ajouter un fichier autant de fois que nécessaire. Pour chaque fichier, il faut ensuite renseigner différents champs :
    • Nom de fichier : Nom du fichier tel qu'il apparaîtra dans les téléchargements.
    • Catégorie : Optionnel. La catégorie vous aide à spécifier l'usage du fichier (OS par exemple) .
    • URL du fichier : Fichier qui sera lié au téléchargement.

 

Attention, les fichiers qui seront proposés au téléchargement doivent impérativement être uploadés depuis la page produit afin de disposer de droits d'accès spécifiques. Si vous les uploadez depuis la page "Médias", ils ne seront pas protégés !

 

Maintenances

Si les maintenances sont activées dans WooSoftware, un onglet Maintenance apparaît dans la saisie des produits WooCommerce lorsque vous cochez la case Versions.

Rendez-vous dans l'onglet Maintenance pour saisir les éléments spécifiques à votre produit :

  • Maintenance appliquée : Cochez cette case pour activer la maintenance sur votre produit.
  • Durée de maintenance initiale offerte : Lors de l'achat du produit, une période de maintenance est offerte. Une période par défaut est spécifiée dans les réglages généraux de WooSoftware. Vous pouvez surcharger cette valeur ici.
  • Prix du renouvellement par an : Vous disposez de plusieurs moyens pour indiquer le prix annuel de la maintenance. Par défaut, il s'agit d'un pourcentage du prix du produit vendu, tel que défini dans les réglages généraux de WooSoftware. Vous pouvez aussi renseigner directement un prix ou changer le pourcentage pour un produit en particulier.

Extensions WordPress

Si vous souhaitez vendre des extensions WordPress, WooSoftware vous permet de renseigner différents champs qui seront affichés sur les sites utilisant vos extensions :

  • Nécessite au moins la version WordPress : Lors de la procédure de mise à jour des extensions, vos clients verront cette information.
  • Testé jusqu'à la version WordPress : Lors de la procédure de mise à jour des extensions, vos clients verront cette information.
  •  : Lorsque vos clients cliquent sur Plus de détails dans la page des extensions, ils verront le texte du produit.
  • Page de description : Lorsque vos clients cliquent sur Plus de détails dans la page des extensions, ils verront le contenu de la page spécifiée.

Versions Lite/Full

Si vous souhaitez proposer des versions allégées gratuites de vos logiciels, il faut activer cette option depuis les paramètres généraux.

L'onglet Versions Lite/Full est disponible uniquement si la fonctionnalité correspondante est activée. L'onglet vous permet de spécifier les fichiers disponibles lorsqu'un client fait une mise à jour de la version gratuite vers la version complète.

Les fichiers de la version gratuite seront ceux spécifiés dans l'onglet Général.

En cochant la case "Activé", vous vous obligez à saisir les nouvelles versions à 2 emplacements lors de l'ajout d'une nouvelle version de votre produit: La version lite/gratuite dans l'onglet Général et la version complète dans l'onglet Versions Lite/Full.

La mise à jour d'une version à l'autre se fait via un appel à l'API lors de l'activation d'une licence.

Utilisation de l'API

Pour nos exemples, nous considèrerons un site vendeur (le site sur lequel est installé WooSoftware) à l'adresse https://mon.exemple.com. Dans la suite, nous considèrerons également que le paramètre Endpoint est laissé à vide. Ainsi, l'adresse de base de notre API sera :

https://mon.exemple.com/wp-admin?admin-ajax.php?action=lwswoosoftware

Il est à noter qu'en cas d'erreur, les logs liés à l'API sur le site vendeur se retrouveront avec ceux de WooCommerce (page d'administration, WooCommerce, État, onglet Logs).

Activation de licence

Lors de l'édition du produit, vous avez déjà saisi l'ID d'API du produit ainsi que la clé secrète. Ces deux informations seront utiles lors de vos appels à l'API.

 

Appel à l'API

Pour activer une licence, le produit devra effectuer une requête HTTP[S] en POST à l'adresse suivante où id_api_produit sera remplacé par la valeur configurée lors de l'édition du produit:

https://mon.exemple.com/wp-admin?admin-ajax.php?action=lwswoosoftware&product=id_api_produit&activate

Les arguments en POST sont les suivants:

  • version : la version actuelle du produit.
  • fingerprint : une valeur identifiant de façon unique le poste d'installation du produit. Il permet d'empêcher un client d'activer la même licence sur plusieurs postes. La construction de cette valeur est laissée à la discrétion du développeur du produit. Toutefois il devra être composé uniquement de caractères alphanumériques, de tirets haut et de tirets bas (par exemple 1234-abc_def est un fingerprint valable).
  • token : la clé de licence générée par WooSoftware est fournie au client lors de l'achat du produit sur le site vendeur. Cette clé a été envoyée au client par mail. Elle est rappelée dans sa page «Mon compte», dans le récapitulatif de la commande concernée.
  • hash : le hash est une valeur de sécurité en hexadécimal. Elle est construite par la concaténation des valeurs suivantes, séparées par des slashs puis encodée en sha256:
    • l'ID API du produit dont la licence doit être activée.
    • la version actuelle du produit.
    • le fingerprint que l'on trouve également en POST.
    • un nonce. Une valeur arbitraire définie par le produit, de préférence aléatoire.
    • la clé_secrète associée au produit. Celle-ci n'est connue que par le produit et le site vendeur. Elle n'est jamais échangée en clair.

Il est également nécessaire de fournir un cookie contenant:

  • nonce : la valeur utilisée dans le hash.

Prenons un exemple pour le hash dont le texte pourrait être :

mon_produit/2.0.1/print-sherlock42/nonce-72616e646f6d/key-123456789

devient après hachage :

a27bf3b0d1291b6ec1dd93752e0435f50c665581992dbe42370c8557d69a48a3

 

Réponse de l'API

À cet appel, l'API répondra :

  • Soit par un code HTTP 400. Certains arguments sont manquants ou ne respectent pas le format imposé.
  • Soit par un code http 200 (ou 301 suivant la configuration du serveur). Le corps de la réponse est alors un tableau JSON contenant les données suivantes :
    • ok : un booléen indiquant si la licence a bien été activée.
    • html : un texte en clair précisant le résultat de l'activation.
    • slug : (présent en cas de succès uniquement) reprend l'ID API du produit dont la licence a été activée.
    • token : (présent en cas de succès uniquement) reprend la clé de licence qui a été activée.
    • fingerprint: (présent en cas de succès uniquement) reprend le fingerprint qui a été associé à la clé de licence sur le site vendeur.
    • hash : (présent en cas de succès uniquement) une valeur de sécurité en hexadécimal. Elle est construite par la concaténation des valeurs suivantes, séparées par des slashs puis encodée en sha256:
      • l'ID API du produit dont la licence a été activée.
      • la clé de licence qui a été activée.
      • la valeur nonce fournie par l'appelant.
      • une valeur arbitraire fournie dans le cookie jointe à la réponse sous la clé rand.
      • la clé_secrète associé au produit: celle-ci n'est connue que par le produit et le site vendeur. Elle n'est jamais échangée en clair.
    • expire : (optionnel) si la clé de licence est temporaire, cette entrée est présente et contient la date d'expiration de la licence au format année sur 4 chiffres, mois sur 2 chiffres, jour sur 2 chiffres séparés par des tirets hauts. Par exemple 2036-02-29.

Téléchargement et mise à jour

Lors de l'édition du produit, vous avez uploadé un ou plusieurs fichiers.

 

Appel à l'API

Pour télécharger un fichier, le produit devra effectuer une requête HTTP[S] en POST à l'adresse suivante où id_api_produit sera remplacé par la valeur configurée lors de l'édition du produit:

https://mon.exemple.com/wp-admin?admin-ajax.php?action=lwswoosoftware&product=id_api_produit&get=vX.X.X

Ici, v.X.X.X doit être remplacé par la version que vous voulez télécharger. Le numéro de la version la plus récente disponible pour un produit peut être demandé à l'API via la fonction d'information sur un produit. Si la gestion des versions n'a pas été activée pour ce produit sur le site vendeur, cette valeur peut rester vide.

Les arguments en POST sont les suivants:

  • product : l'ID API du produit.
  • version : la version désirée du produit. Cette information doit être la même que celle de l'argument get ci-dessus. Si la gestion des versions n'a pas été activée pour ce produit sur le site vendeur, cette valeur peut rester vide.
  • token : la clé de licence générée par WooSoftware et fournie au client lors de l'achat du produit sur le site vendeur. Cette clé a été envoyée au client par mail. Elle est rappelée dans sa page «Mon compte», dans le récapitulatif de la commande concernée.
  • fingerprint : une valeur identifiant de façon unique le poste d'installation du produit. Il doit s'agir de la même valeur associée au token lors le l'activation de la licence.
  • category: (optionnel) si plusieurs fichiers sont disponibles pour une même version, ce paramètre permet de filtrer les fichiers à télécharger. Si la gestion des versions est désactivée sur le produit, ce filtre s'applique sur le nom des fichiers. Si n'y a qu'un seul fichier à télécharger, celui-ci est envoyé tel quel. Si plusieurs fichiers sont disponibles malgré le filtre, il sont alors compressés en une seule archive zip qui est ensuite envoyée.
  • hash :le hash est une valeur de sécurité en hexadécimal. Elle est construite par la concaténation des valeurs suivantes, séparées par des slashs puis encodée en sha256:
    • l'ID API du produit dont la licence doit être activée.
    • la version désirée du produit (s'il n'y a pas de version, considérez une chaine vide).
    • le fingerprint que l'ont trouve également en POST.
    • une chaine vide (valeur réservée).
    • la clé_secrète associée au produit. Celle-ci n'est connue que par le produit et le site vendeur. Elle n'est jamais échangée en clair.

Prenons un exemple pour le hash dont le texte pourrait être :

mon_produit/v2.0.1/print-sherlock42//key-123456789

devient après hachage :

46b6f23d4bdf0ed4c8d51cd5c69ce27e112af71937b75f7ff8ea93eeca2492ff

 

Réponse de l'API

En cas de succès, l'entête de la réponse pourra être un code HTTP 200, 206 ou 301 suivant la configuration du serveur. La réponse en elle-même est le fichier demandé s'il n'y en a qu'un ou l'ensemble des fichiers groupé dans une archive au format zip s'il y en a plusieurs.

En cas d'échec, l'entête de la réponse pourra être un code HTTP :

  • entre 400 et 499, votre requête est invalide, la licence n'existe pas, n'est pas active ou expirée, ou il n'y a pas de fichier à envoyer.
  • entre 500 et 527, le serveur a un problème. Il faudra alors ré-essayer ultérieurement ou contacter le vendeur.

Informations sur le produit

Lors de l'édition du produit, vous avez déjà saisi l'ID d'API du produit ainsi que la clé secrète. Ces deux informations seront utiles lors de vos appels à l'API.

Appel à l'API

Pour obtenir des informations sur un produit, l'appelant devra effectuer une requête HTTP[S] à l'adresse suivante où id_api_produit sera remplacé par la valeur configurée lors de l'édition du produit:

https://mon.exemple.com/wp-admin?admin-ajax.php?action=lwswoosoftware&product=id_api_produit&info

Si vous disposez d'une clé de licence pour ce produit, il est possible de la préciser de manière optionnelle en POST.

Si la gestion lite/full est activée, ces paramètres permettront de déterminer si les informations retournées concernent les fichiers en version gratuite/allégée ou payante.

Les arguments en POST sont les suivants:

  • key: la clé de licence générée par WooSoftware et fournie au client lors de l'achat du produit sur le site vendeur. Cette clé a été envoyée au client par mail. Elle est rappelée dans sa page «Mon compte», dans le récapitulatif de la commande concernée.
  • force: (optionnel) si une maintenance est en cours sur le produit et que key est précisé, la version retournée sera la dernière accessible en tenant compte de cette maintenance. Préciser cet argument pour ignorer cette restriction (attention, il se peut que la version retournée ne soit pas disponible au téléchargement si la maintenance a expiré).

 

Réponse de l'API

En cas de succès, l'entête de la réponse pourra être un code HTTP 200 ou 301 suivant la configuration du serveur. Le corps de la réponse est un tableau JSON contenant les entrées suivantes (ces données sont compatibles avec le système de mise à jour d'extensions WordPress. Certaines précision peuvent être ajoutées à l'édition du produit) :

  • slug : c'est l'ID API du produit
  • plugin_name : c'est le nom public du produit.
  • download_link : le lien vers l'API pour télécharger les fichiers.
  • version : la version la plus récente disponible. Si une clé est précisée et qu'une maintenance existe ET si force n'est pas présent dans la requête, alors c'est la version la plus récente téléchargeable.
  • categories: Si plusieurs fichiers sont disponibles, l'entrée categories est ajoutée. C'est un tableau JSON contenant les catégories associés aux fichiers de la dernière version si la gestion des versions est activée pour le produit. Sinon, c'est un tableau JSON contenant la liste des noms des fichiers disponibles.

Si les valeurs ont été précisées à l'édition du produit, les champs suivants sont ajoutés au tableau JSON:

  • author : l'auteur du produit.
  • requires : la version minimale de WordPress requise par le produit.
  • tested : la dernière version de WordPress sur laquelle le produit à été testé par les développeurs.

Les champs suivants sont ajoutés afin d'améliorer le rendu des écrans de mise à jour lorsque le produit est une extension WordPress:

  • last_update : la date de dernière mise à jour du produit.
  • homepage : l'URL du site vendeur.
  • icons : un tableau JSON contenant l'image liée au produit.
  • sections : un tableau JSON contenant:
    • description: le texte associé au produit.
    • changelog : si la gestion des versions est activée, le contenu de ce champ est généré à partir des informations saisies dans chaque version. Sinon, le texte est en saisie libre à l'édition du produit.

En cas d'échec, l'entête de la réponse pourra être un code HTTP :

  • entre 400 et 499, votre requête est invalide, le produit est introuvable, la licence n'existe pas, n'est pas active ou expirée. Si la clé de licence n'a pas été précisée, il est possible que le produit ne propose pas de version gratuite.
  • entre 500 et 527, le serveur a un problème. Il faudra alors ré-essayer ultérieurement ou contacter le vendeur.