API WebService
AnswerKit ajoute deux ressources à l’API WebService de PrestaShop. Un PIM, un ERP ou un simple script peut ainsi créer et tenir à jour vos FAQ, comme il le fait déjà pour les produits.
| Ressource | Contenu |
|---|---|
answerkit_items | Les questions : active, et question et answer dans chaque langue |
answerkit_links | Où chaque question s’affiche : id_item, type, id_object, position |
Donner les droits à une clé
- Paramètres avancés > Webservice : vérifiez que le service web est activé.
- Créez une clé (ou modifiez la vôtre) et cochez les droits voulus (GET, POST, PUT, DELETE) sur answerkit_items et answerkit_links.
- Enregistrez.
À la désinstallation du module, ces droits sont retirés de toutes les clés.
Créer une question
POST /api/answerkit_items
<prestashop>
<answerkit_item>
<active>1</active>
<question>
<language id="1">Comment choisir ma taille ?</language>
<language id="2">How do I choose my size?</language>
</question>
<answer>
<language id="1"><![CDATA[<p>Prenez votre taille habituelle.</p>]]></language>
<language id="2"><![CDATA[<p>Take your usual size.</p>]]></language>
</answer>
</answerkit_item>
</prestashop>
Les id de langue sont ceux de votre boutique (International > Localisation > Langues). La réponse
renvoie l’id de la question créée.
L’afficher sur une page
POST /api/answerkit_links
<prestashop>
<answerkit_link>
<id_item>42</id_item>
<type>product</type>
<id_object>12</id_object>
<position>0</position>
</answerkit_link>
</prestashop>
type | id_object |
|---|---|
product | id du produit |
category | id de la catégorie |
manufacturer | id de la marque |
cms | id de la page CMS |
home | 0 (page d’accueil) |
all | 0 (tous les produits) |
position fixe l’ordre sur la page (les plus petites d’abord). Un lien vers une question, un produit, une
catégorie, une marque ou une page qui n’existe pas est refusé avec un message clair.
Lire, modifier, supprimer
Comme pour toute ressource PrestaShop :
GET /api/answerkit_items?display=full: toutes les questions ;GET /api/answerkit_links?filter[type]=product&filter[id_object]=12&display=full: les questions d’un produit ;PUT /api/answerkit_items/42: modifier une question ;DELETE /api/answerkit_items/42: supprimer une question et tous ses liens ;DELETE /api/answerkit_links/7: retirer la question d’une page, sans la supprimer.
Ce que fait le module à chaque écriture
- Les réponses passent par le même nettoyage que le back-office : une balise interdite est retirée, pas
refusée ; les liens
javascript:etdata:sont bloqués. - Le cache de la FAQ est vidé : la boutique affiche tout de suite la nouvelle version.
- Remplissez au moins la langue par défaut : c’est elle que montre le back-office. En boutique, chaque langue n’affiche que les questions qui y ont une question et une réponse.