Prezentare generală a endpointurilor
Tabelul de mai jos reflectă rutele publice montate în backend-public-api/app.js. Căile sunt afișate cu prefixul proxy public folosit de integrările externe.
| Metodă | Endpoint | Descriere | Acces |
|---|---|---|---|
GET | /public-api/healthz | Verificarea disponibilității serviciului. | public |
GET | /public-api/v1/auth/check | Validează credențialele și returnează magazinul, domeniile de acces și funcționalitățile planului. | orice set de credențiale autentificat |
GET | /public-api/v1/customer-orders | Returnează o listă paginată și filtrabilă a comenzilor clienților. | orders:read |
GET | /public-api/v1/customer-orders/:id | Returnează o comandă de client cu articole de produs configurate. | orders:read |
POST | /public-api/v1/customer-orders/batch | Returnează până la 100 de comenzi după ID. | orders:read |
PATCH | /public-api/v1/customer-orders/:id/status | Actualizează starea comenzii. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity | Actualizează cantitățile pozițiilor selectate din comandă. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity/all | Setează o singură cantitate pentru fiecare articol dintr-o comandă. | orders:write |
DELETE | /public-api/v1/customer-orders/:id | Șterge o comandă de client care aparține proprietarului magazinului. | orders:write |
GET | /public-api/v1/products | Returnează produse/designuri ale magazinului cu disponibilitatea încorporării și URL-urile media. | products:read |
GET | /public-api/v1/products/:id | Returnează un produs/design al magazinului. | products:read |
POST | /public-api/v1/embed/session | Emite un JWT cu durată scurtă de valabilitate pentru instrumentele încorporate, inclusiv generatorul de modele. | embed:session:create |
GET | /public-api/v1/runtime/bootstrap | Determină contextul de execuție dintr-un JWT de încorporare. | token de încorporare Bearer |
GET | /public-api/v1/assets | Listează elementele catalogului de resurse pentru tipul solicitat. | orice set de credențiale autentificat |
GET | /public-api/v1/assets/:type/:assetId | Returnează un manifest de resursă cu rolurile fișierelor descărcabile. | orice set de credențiale autentificat |
GET | /public-api/v1/assets/:type/:assetId/files/:role | Descarcă un fișier de resursă după rol. | orice set de credențiale autentificat |
GET | /public-api/v1/design-imports | Listează designurile găzduite pe Alter care pot fi importate. | set de credențiale autentificat, plan Business obligatoriu |
GET | /public-api/v1/design-imports/:id | Returnează un payload de import de design și descriptori de fișiere. | set de credențiale autentificat, plan Business obligatoriu |
GET | /public-api/v1/design-imports/:id/files/:fileId | Descarcă un fișier dintr-un descriptor de import de design. | set de credențiale autentificat, plan Business obligatoriu |
GET | /public-api/v1/file/public/products/:productId/:size | Returnează o previzualizare publică a produsului. Dimensiunea trebuie să fie small.png, medium.png sau big.png. | public |
GET | /public-api/v1/file/protected/:key | Returnează un fișier protejat după cheia de stocare. | URL semnat sau files:read |
GET | /public-api/v1/fonts | Returnează toate fonturile disponibile. | public |
GET | /public-api/v1/currencies | Returnează toate monedele. | public |
POST | /public-api/v1/runtime-bindings/sync-from-wordpress | Creează sau actualizează asocieri de execuție din mapările produselor WordPress. | orice set de credențiale autentificat |
PATCH | /public-api/v1/runtime-bindings/:id | Modifică parțial o asociere de execuție. | orice set de credențiale autentificat |
POST | /public-api/v1/runtime-bindings/:id/activate | Activează o asociere de execuție. | orice set de credențiale autentificat |
POST | /public-api/v1/runtime-bindings/:id/deactivate | Dezactivează o asociere de execuție. | orice set de credențiale autentificat |
POST | /public-api/v1/wp-connect/exchange | Schimbă un cod de transfer al conectării automate WordPress cu credențiale API. | cod de transfer de unică folosință |
GET | /public-api/v1/model-generator/catalog | Listează produsele vizibile ale generatorului, configurațiile și reviziile șabloanelor. | embed:session:create |
GET | /public-api/v1/model-generator/models | Listează modelele cu descriptori care fixează reviziile sursă ale generatorului pentru import. | embed:session:create |
GET | /public-api/v1/model-generator/designer-catalog | Returnează catalogul de modele ale generatorului folosit de Designer. | embed:session:create |
GET | /public-api/v1/model-generator/projects | Listează proiectele de generator ale proprietarului și cele disponibile global. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId | Returnează cea mai recentă revizie a proiectului sau revizia selectată, șablonul și manifestul fișierelor. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | Returnează cea mai recentă revizie a proiectului sau revizia selectată, șablonul și manifestul fișierelor. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId | Descarcă un artefact după verificarea accesului la proiectul său. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template | Returnează un document de șablon accesibil pentru revizia de configurație selectată. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import | Returnează pachetul de import al șablonului împreună cu fișierele de dependențe. | embed:session:create |
GET | /public-api/v1/model-generator/mannequins | Returnează ambele manechine și descriptorii resurselor lor. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets | Listează resursele bibliotecii de texturi sau fundaluri cu fișierele care pot fi importate. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets/:assetId | Returnează o resursă de textură sau fundal împreună cu fișierele care pot fi importate. | embed:session:create |
GET | /public-api/v1/model-generator/public-files/:key | Descarcă un fișier de dependență permis al generatorului. | embed:session:create |