ecomyseo/prestashop_skills / prestashop-webservice-extend
prestashop-webservice-extend
VerifiedSkill for adding new resources to the legacy XML WebService in PrestaShop.
PrestaShop WebService Extend Skill
This skill explains how to expose module entities through the legacy PrestaShop WebService API.
1. Technical Guide
Registering the Hook
The module must register the addWebserviceResources hook.
public function install()
{
return parent::install() && $this->registerHook('addWebserviceResources');
}
Exposing the Resource
Return an array where the key is the alias of the resource and the value contains the class name and description.
public function hookAddWebserviceResources($params)
{
return [
'my_module_articles' => [
'description' => 'Access to module articles',
'class' => 'MyArticle', // Must extend ObjectModel
'forbidden_method' => [] // Optional: ['DELETE', 'PUT']
]
];
}
2. Professional Development Guide
ObjectModel Requirement
The class specified in the WS resource MUST be an ObjectModel and must be correctly loaded or autoloaded.
class MyArticle extends ObjectModel
{
public $title;
public static $definition = [
'table' => 'my_article',
'primary' => 'id_my_article',
'fields' => [
'title' => ['type' => self::TYPE_STRING, 'validate' => 'isString', 'webservice' => true],
],
];
}
Security
Ensure that all fields you want to expose have 'webservice' => true in their definition. Fields without this property or set to false will be hidden in the API.
3. User Guide
How to use
- Go to Advanced Parameters > Web Service.
- Create or edit an API Key.
- You will see
my_module_articlesin the list of permissions. Grant GET, POST, etc. as needed.
Rules & Best Practices
- Aliases: Use a prefix with your module name to avoid resource name collisions.
- Performance: For large datasets, the XML WebService can be slow. Consider using the new REST API for PrestaShop 9.
- Licensing: Always include the Ecom Experts / AFL-3.0 header.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| reverse-engineer-anythingmorluto/reaReverse engineer native, managed, Electron/JavaScript, packaged, firmware, and browser targets with REA, and build agent environments (AgentEnv bundles) of web applications from a live instance or a capture, and of Linux desktop apps with a task from a request. Use shipped-artifact or requested runtime evidence to explain features, compare versions, decompile code, or guide a reconstruction. Skip REA for ordinary source-repository architecture analysis. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| diagnosing-superpowersobra/superpowersUse when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness. | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| dispatching-parallel-agentsobra/superpowersUse when facing 2+ independent tasks that can be worked on without shared state or sequential dependencies | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| executing-plansobra/superpowersUse when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is available | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |