Webcosa pour les développeurs
Documentation développeur
Webcosa habille les sites de ses clients avec des thèmes Liquid au format Shopify. Cette documentation dit ce qu’un thème peut lire, écrire et rendre, comment le pousser depuis ton éditeur, et ce que l’API expose à qui veut automatiser le reste.
Les trois surfaces
Un thème, un outil pour l’écrire, une API pour tout le reste. On peut n’en connaître qu’une : elles ne se supposent pas l’une l’autre.
Habille un site avec du Liquid, au format Shopify. Six dossiers, des sections déclarées par un schéma, et un panneau de réglages que le client remplit tout seul.
Édite tes thèmes depuis ton éditeur, pousse-les en une commande. Node 20.13 ou plus, aucune dépendance, et chaque sauvegarde en ligne si tu le demandes.
Automatise ce que fait le CMS. C’est l’API que le CLI utilise lui-même : clés à portée, thèmes, fichiers, import et export d’un thème entier.
Commencer en trois commandes
Le CLI tient dans un fichier, ne demande que Node 20.13 ou plus, et se copie où l’on veut. Il ne rend pas de Liquid en local — c’est le site lui-même qui sert d’aperçu, et la raison en vaut la peine.
- Créer une clé d’API
Dans le CMS, Réglages → Clés d’API. Portée
lecturepour regarder,themespour écrire. Le secret ne s’affiche qu’une fois : la base n’en garde que l’empreinte. - L’enregistrer sur ta machine
connexiondemande l’adresse du CMS puis la clé, sans l’afficher, la vérifie, et ne l’écrit qu’ensuite — dans~/.webcosa/config.json, en 0600. Une clé qui ne marche pas n’est pas enregistrée. - Récupérer, éditer, pousser
recupererécrit l’arborescence du thème et pose un.webcosa.json: les commandes suivantes n’ont plus besoin d’une seule option. Un thème poussé arrive toujours en brouillon.
node scripts/theme.mjs connexionnode scripts/theme.mjs recuperer --theme=Atelier --dossier=~/themes/ateliernode scripts/theme.mjs pousser ↑ modifié assets/theme.css
+ nouveau sections/temoignages.liquid
✓ 1 nouveau, 1 modifié, 3 inchangéspousser compare les empreintes SHA-256 et n’envoie que ce qui a changé. Pour que chaque sauvegarde parte toute seule : suivre. Les fichiers présents à distance et absents en local sont signalés, pas supprimés.
Par où commencer
Quatre parcours complets, du dossier vide au thème publié. Chacun se lit d’une traite.
La référence en un coup d’œil
Tout ce qu’un thème peut lire et tout ce qu’on peut lui faire, sur un écran. Les listes sont fermées : ce qui n’y figure pas n’existe pas.