API Adapter

Creazione file in FTP

Version ≥ 3.7

La chiamata consente di creare un file a partire da una URL e salvarlo nel percorso path + filename. Se vengono inviati più messaggi, ciascuno genererà un file con la stessa logica.

warning

Per far si che i file possano essere visti dall'FTP bisogna che le cartelle siano mappate in modo coerente tra i container Docker, in modo che puntino allo stesso percorso.

POST/api/adp/egress/create-files-ftp

Headers: Autenticazione

Key	Tipo	Default
overwrite-existing-files	bool	false

Query Params Parametri non presenti

Body

Body Request

{
    "action": "execute",
    "messages": [
{
    "msgId": "640ee776f545844f1472f0bc",
    "msg": {
    "path": "/immagini",
    "fileName": "img-1.jpg",
    "url": "https://picture-shared-cdn-gyc0grarcthdbrdw.a03.azurefd.net/cdn/EYEOO/images/AQflAS4R0wjLruAj3KUCjMQgL67ZTEieOfrYG-mGRgwiqgxL2gZR4gSy39RV-6-dl8azf__8VJc"
},
    "meta": {}
}
    ],
    "requestId": "da7314de6b50407c9bf1b99acdadf65f",
    "meta": {}
}

Body Response Il body della risposta è compatibile con Flowlyze. Per ogni messaggio inviato sarà restituito l'esito, l'id del messaggio e la data di risposta.

Body Response 200 OK

{
    "requestId": "da7314de6b50407c9bf1b99acdadf65f",
    "isAsync": false,
    "messages": [
{
    "msgId": "640ee776f545844f1472f0bc",
    "status": "Success",
    "date": "2025-10-28T13:28:26+00:00"
}
    ]
}

Body Response 400 Bad Request

{
    "requestId": "da7314de6b50407c9bf1b99acdadf65f",
    "isAsync": false,
    "messages": [
{
    "msgId": "640ee776f545844f1472f0bc",
    "status": "Error",
    "date": "2025-10-28T13:59:36+00:00",
    "errorMessage": "'url' is empty or not valid"
}
    ]
}

Creazione file CSV

Version ≥ 3.8

La chiamata consente di creare un file .csv all'interno della sezione Assets di pimcore, salvato nel percorso path + filename. Se vengono inviati più messaggi, ciascuno genererà un file con la stessa logica.

Se il file è già presente nel percorso indicato, verrà verificato se le colonne passate nella richiesta corrispondono a quelle nel file già presente. Nel caso siano uguali allora le righe specificate in rows verranno aggiunte in append al file altrimenti verrà restituito un errore.

POST/api/adp/egress/create-asset-csv

Headers: Autenticazione

Key	Tipo	Default
csv-delimiter	string	;

Query Params Parametri non presenti

Body

Body Request

{
  "action": "execute",
  "messages": [
    {
      "msgId": "640ee776f545844f1472f0bd",
      "msg": {
        "fileName": "csv-test-123.csv",
        "path": "/csv",
        "rows": [
          {
              "sku": "67878e279a2fe",
              "product_name": "Concerned Caracal"
          },
          {
              "sku": "67878e2af3e36",
              "product_name": "Ugly Unicorn"
          }
        ]
      },
      "meta": {}
    }
  ],
  "requestId": "da7314de6b50407c9bf1b99acdadf65g",
  "meta": {}
}

Body Response Il body della risposta è compatibile con Flowlize. Per ogni messaggio inviato sarà restituito l'esito, l'id del messaggio e la data di risposta.

Body Response 200 OK

{
  "requestId": "da7314de6b50407c9bf1b99acdadf65g",
  "isAsync": false,
  "messages": [
    {
      "msgId": "640ee776f545844f1472f0bd",
      "status": "Success",
      "date": "2025-10-28T13:28:26+00:00"
    }
  ]
}

Body Response 400 Bad Request

  {
    "requestId": "da7314de6b50407c9bf1b99acdadf65g",
    "isAsync": false,
    "messages": [
      {
        "msgId": "640ee776f545844f1472f0bd",
        "status": "Error",
        "date": "2025-10-28T13:59:36+00:00",
        "errorMessage": "'filename' is required and must be a CSV file"
      }
    ]
  }