Panoramica degli endpoint
La tabella seguente rispecchia le route pubbliche montate in backend-public-api/app.js. I percorsi sono mostrati con il prefisso del proxy pubblico usato dalle integrazioni esterne.
| Metodo | Endpoint | Descrizione | Accesso |
|---|---|---|---|
GET | /public-api/healthz | Verifica della disponibilità del servizio. | pubblico |
GET | /public-api/v1/auth/check | Convalida le credenziali e restituisce negozio, ambiti e funzionalità del piano. | qualsiasi credenziale autenticata |
GET | /public-api/v1/customer-orders | Restituisce un elenco paginato e filtrabile degli ordini dei clienti. | orders:read |
GET | /public-api/v1/customer-orders/:id | Restituisce un singolo ordine cliente con articoli di prodotto configurati. | orders:read |
POST | /public-api/v1/customer-orders/batch | Restituisce fino a 100 ordini tramite ID. | orders:read |
PATCH | /public-api/v1/customer-orders/:id/status | Aggiorna lo stato dell'ordine. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity | Aggiorna le quantità delle righe d'ordine selezionate. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity/all | Imposta un'unica quantità per ogni articolo di un ordine. | orders:write |
DELETE | /public-api/v1/customer-orders/:id | Elimina un ordine cliente appartenente al proprietario del negozio. | orders:write |
GET | /public-api/v1/products | Restituisce prodotti/design del negozio con disponibilità di incorporamento e URL dei contenuti multimediali. | products:read |
GET | /public-api/v1/products/:id | Restituisce un prodotto/design del negozio. | products:read |
POST | /public-api/v1/embed/session | Emette un JWT di breve durata per gli strumenti incorporati, incluso il generatore di modelli. | embed:session:create |
GET | /public-api/v1/runtime/bootstrap | Risolve il contesto runtime da un JWT di incorporamento. | token di incorporamento Bearer |
GET | /public-api/v1/assets | Elenca gli elementi del catalogo delle risorse per il tipo richiesto. | qualsiasi credenziale autenticata |
GET | /public-api/v1/assets/:type/:assetId | Restituisce un manifesto della risorsa con i ruoli dei file scaricabili. | qualsiasi credenziale autenticata |
GET | /public-api/v1/assets/:type/:assetId/files/:role | Scarica un file di risorsa in base al ruolo. | qualsiasi credenziale autenticata |
GET | /public-api/v1/design-imports | Elenca i design ospitati su Alter disponibili per l'importazione. | credenziale autenticata, piano Business richiesto |
GET | /public-api/v1/design-imports/:id | Restituisce un payload di importazione del design e descrittori dei file. | credenziale autenticata, piano Business richiesto |
GET | /public-api/v1/design-imports/:id/files/:fileId | Scarica un file da un descrittore di importazione del design. | credenziale autenticata, piano Business richiesto |
GET | /public-api/v1/file/public/products/:productId/:size | Restituisce un'anteprima pubblica del prodotto. La dimensione deve essere small.png, medium.png o big.png. | pubblico |
GET | /public-api/v1/file/protected/:key | Restituisce un file protetto tramite la chiave di archiviazione. | URL firmato o files:read |
GET | /public-api/v1/fonts | Restituisce tutti i font disponibili. | pubblico |
GET | /public-api/v1/currencies | Restituisce tutte le valute. | pubblico |
POST | /public-api/v1/runtime-bindings/sync-from-wordpress | Crea o aggiorna associazioni runtime a partire dalle mappature dei prodotti WordPress. | qualsiasi credenziale autenticata |
PATCH | /public-api/v1/runtime-bindings/:id | Modifica parzialmente un'associazione runtime. | qualsiasi credenziale autenticata |
POST | /public-api/v1/runtime-bindings/:id/activate | Attiva un'associazione runtime. | qualsiasi credenziale autenticata |
POST | /public-api/v1/runtime-bindings/:id/deactivate | Disattiva un'associazione runtime. | qualsiasi credenziale autenticata |
POST | /public-api/v1/wp-connect/exchange | Scambia un codice di passaggio della connessione automatica WordPress con credenziali API. | codice di passaggio monouso |
GET | /public-api/v1/model-generator/catalog | Elenca i prodotti del generatore, le configurazioni e le revisioni dei template visibili. | embed:session:create |
GET | /public-api/v1/model-generator/models | Elenca i modelli con descrittori delle sorgenti del generatore fissati a revisioni specifiche per l’importazione. | embed:session:create |
GET | /public-api/v1/model-generator/designer-catalog | Restituisce il catalogo dei modelli del generatore utilizzato da Designer. | embed:session:create |
GET | /public-api/v1/model-generator/projects | Elenca i progetti del generatore del proprietario e quelli disponibili globalmente. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId | Restituisce la revisione più recente o selezionata del progetto, il template e il manifest dei file. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | Restituisce la revisione più recente o selezionata del progetto, il template e il manifest dei file. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId | Scarica un artefatto dopo aver verificato l’accesso al relativo progetto. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template | Restituisce un documento di template accessibile per la revisione di configurazione selezionata. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import | Restituisce il pacchetto di importazione del template con i file delle dipendenze. | embed:session:create |
GET | /public-api/v1/model-generator/mannequins | Restituisce entrambi i manichini e i descrittori delle loro risorse. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets | Elenca le risorse delle librerie di texture o sfondi con i file importabili. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets/:assetId | Restituisce una singola risorsa di texture o sfondo con i relativi file importabili. | embed:session:create |
GET | /public-api/v1/model-generator/public-files/:key | Scarica un file di dipendenza consentito del generatore. | embed:session:create |