ecomyseo/prestashop_skills / prestashop-api-module
prestashop-api-module
VerifiedSkill para crear y extender APIs en PrestaShop 8 (WebService legacy) y PrestaShop 9 (API Platform + WebService).
PrestaShop API Module Skill
Este skill cubre los DOS sistemas de API disponibles segun la version de PrestaShop.
IMPORTANTE: PS 8 y PS 9 usan sistemas de API completamente diferentes. No confundirlos.
Matriz de Compatibilidad
| Sistema | PS 8 | PS 9 |
|---|---|---|
| WebService Legacy (XML) | Unico disponible | Disponible (deprecated) |
| API Platform (REST/JSON) | NO existe | Nuevo sistema principal |
1. WebService Legacy (PS 8 + PS 9)
El sistema clasico basado en XML y ObjectModel. Funciona en ambas versiones.
Hook de Registro
public function install()
{
return parent::install() && $this->registerHook('addWebserviceResources');
}
Exponer un Recurso
public function hookAddWebserviceResources($params)
{
return [
'my_module_articles' => [
'description' => 'Access to module articles',
'class' => 'MyArticle', // Debe extender ObjectModel
'forbidden_method' => [], // Opcional: ['DELETE', 'PUT']
],
];
}
ObjectModel Requerido
class MyArticle extends ObjectModel
{
public $title;
public static $definition = [
'table' => 'my_article',
'primary' => 'id_my_article',
'fields' => [
'title' => [
'type' => self::TYPE_STRING,
'validate' => 'isGenericName',
'size' => 255,
'webservice' => true,
],
],
];
}
Uso del WebService
- Ir a Parametros Avanzados > Webservice.
- Crear o editar una API Key.
- El recurso
my_module_articlesaparecera en la lista de permisos. - Autenticacion via HTTP Basic Auth con la API Key como usuario.
GET https://mitienda.com/api/my_module_articles
Authorization: Basic BASE64(API_KEY:)
2. API Platform (SOLO PS 9)
PrestaShop 9 introduce un sistema nuevo basado en API Platform y Symfony 6.4 con autenticacion OAuth2.
NO confundir con el WebService legacy. Son sistemas independientes con rutas, autenticacion y formatos diferentes.
Definir un API Resource
Crear configuracion en src/Resources/api_platform/:
# src/Resources/api_platform/my_entity.yml
resources:
MyModule\ApiPlatform\Resource\MyEntity:
shortName: 'MyEntity'
description: 'Operations for my custom entity'
operations:
ApiPlatform\Metadata\Get:
provider: MyModule\ApiPlatform\State\MyEntityProvider
ApiPlatform\Metadata\GetCollection:
provider: MyModule\ApiPlatform\State\MyEntityCollectionProvider
ApiPlatform\Metadata\Post:
processor: MyModule\ApiPlatform\State\MyEntityProcessor
normalizationContext:
groups: ['my_entity:read']
denormalizationContext:
groups: ['my_entity:write']
State Provider (lectura)
declare(strict_types=1);
namespace MyModule\ApiPlatform\State;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\State\ProviderInterface;
final class MyEntityProvider implements ProviderInterface
{
public function __construct(
private readonly \Db $db
) {
}
public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
{
// Logica para obtener datos
$id = (int) ($uriVariables['id'] ?? 0);
// ...
}
}
State Processor (escritura)
declare(strict_types=1);
namespace MyModule\ApiPlatform\State;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\State\ProcessorInterface;
final class MyEntityProcessor implements ProcessorInterface
{
public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = []): mixed
{
// Logica para guardar datos
return $data;
}
}
Autenticacion OAuth2 (PS 9)
PS 9 usa OAuth2 con scopes. NO usa la pagina de WebService ni X-API-Key.
- Configurar cliente OAuth2 en el admin de PS 9 (Parametros Avanzados > Authorization Server).
- Obtener un token:
POST /admin-api/access_token
Content-Type: application/x-www-form-urlencoded
client_id=MY_CLIENT_ID&client_secret=MY_SECRET&grant_type=client_credentials&scope=my_scope
- Usar el token:
GET /api/my-entities
Authorization: Bearer <access_token>
Documentacion Interactiva
Disponible en /api/docs (Swagger UI) en instalaciones PS 9.
3. Reglas y Buenas Practicas
- Strict Types: Usar
declare(strict_types=1);en todas las clases API. - Validadores: Usar validadores reales de PrestaShop (
isGenericName,isCleanHtml, etc.). NO existeisString. - Prefijos: Usar nombre del modulo como prefijo en recursos para evitar colisiones.
- Rendimiento: El WebService XML puede ser lento con datasets grandes. En PS 9, preferir API Platform.
- Campos multilenguaje: En WebService, marcar con
'lang' => trueen la definicion del ObjectModel.
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: 468k | 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: 319k | 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: 319k | 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: 319k | Updated | Claude CodeCodex | Verified | Install |