Reference

API modułu

API modułu pozwala sklepowi pobrać dostępne scenariusze, uruchomić scenariusz i odczytać historię runów.

Autoryzacja

Moduł sklepu wysyła klucz w nagłówku X-Shop-Api-Key. Klucz jest generowany w panelu i pokazywany tylko raz. Nie należy umieszczać go w publicznym repozytorium, logach ani dokumentacji klienta.

X-Shop-Api-Key: <shop-module-api-key>

Endpointy

`GET /api/module/scenarios`	Lista aktywnych scenariuszy przypisanych do sklepu.
`POST /api/module/scenarios/{code}/execute`	Utworzenie runu i dodanie go do kolejki.
`GET /api/module/scenarios/{code}/runs`	Lista runów scenariusza dla sklepu, z paginacją.
`GET /api/module/scenarios/{code}/runs/{runId}`	Szczegóły pojedynczego runu.

Payload wykonania

{
  "prestashop_product_id": 123,
  "dry_run": true,
  "language_id": 1,
  "with_image": 1,
  "force_update": 0,
  "force_update_global": 0,
  "module_settings": {},
  "prestashop_context": {
    "id_shop": 1,
    "id_lang": 1
  }
}

dry_run powinien być domyślną wartością dla testów. Pola zależą od scenariusza i systemu źródłowego.

Statusy

Odpowiedź po utworzeniu runu ma status HTTP 202 i zawiera run_id. Wynik końcowy należy odczytać z historii runów.