Visão geral dos endpoints
A tabela abaixo reflete as rotas públicas montadas em backend-public-api/app.js. Os caminhos são exibidos com o prefixo de proxy público usado pelas integrações externas.
| Método | Endpoint | Descrição | Acesso |
|---|---|---|---|
GET | /public-api/healthz | Verificação de disponibilidade do serviço. | público |
GET | /public-api/v1/auth/check | Valida as credenciais e retorna a loja, os escopos e os recursos do plano. | qualquer credencial autenticada |
GET | /public-api/v1/customer-orders | Retorna uma lista paginada e filtrável de pedidos de clientes. | orders:read |
GET | /public-api/v1/customer-orders/:id | Retorna um pedido de cliente individual com os itens de produto configurados. | orders:read |
POST | /public-api/v1/customer-orders/batch | Retorna até 100 pedidos por ID. | orders:read |
PATCH | /public-api/v1/customer-orders/:id/status | Atualiza o status do pedido. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity | Atualiza as quantidades dos itens selecionados do pedido. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity/all | Define uma única quantidade para todos os itens de um pedido. | orders:write |
DELETE | /public-api/v1/customer-orders/:id | Exclui um pedido de cliente pertencente ao proprietário da loja. | orders:write |
GET | /public-api/v1/products | Retorna produtos/designs da loja com disponibilidade de incorporação e URLs de mídia. | products:read |
GET | /public-api/v1/products/:id | Retorna um produto/design da loja. | products:read |
POST | /public-api/v1/embed/session | Emite um JWT de curta duração para ferramentas incorporadas, incluindo o gerador de modelos. | embed:session:create |
GET | /public-api/v1/runtime/bootstrap | Resolve o contexto do runtime a partir de um JWT de incorporação. | token de incorporação Bearer |
GET | /public-api/v1/assets | Lista os itens do catálogo de recursos do tipo solicitado. | qualquer credencial autenticada |
GET | /public-api/v1/assets/:type/:assetId | Retorna um manifesto de recurso com as funções dos arquivos disponíveis para download. | qualquer credencial autenticada |
GET | /public-api/v1/assets/:type/:assetId/files/:role | Baixa um arquivo de recurso pela função. | qualquer credencial autenticada |
GET | /public-api/v1/design-imports | Lista os designs hospedados no Alter disponíveis para importação. | credencial autenticada, plano Business obrigatório |
GET | /public-api/v1/design-imports/:id | Retorna um payload de importação de design e descritores de arquivos. | credencial autenticada, plano Business obrigatório |
GET | /public-api/v1/design-imports/:id/files/:fileId | Baixa um arquivo a partir de um descritor de importação de design. | credencial autenticada, plano Business obrigatório |
GET | /public-api/v1/file/public/products/:productId/:size | Retorna uma prévia pública de produto. O tamanho deve ser small.png, medium.png ou big.png. | público |
GET | /public-api/v1/file/protected/:key | Retorna um arquivo protegido pela chave de armazenamento. | URL assinada ou files:read |
GET | /public-api/v1/fonts | Retorna todas as fontes disponíveis. | público |
GET | /public-api/v1/currencies | Retorna todas as moedas. | público |
POST | /public-api/v1/runtime-bindings/sync-from-wordpress | Cria ou atualiza associações de runtime a partir das associações de produtos do WordPress. | qualquer credencial autenticada |
PATCH | /public-api/v1/runtime-bindings/:id | Altera parcialmente uma associação de runtime. | qualquer credencial autenticada |
POST | /public-api/v1/runtime-bindings/:id/activate | Ativa uma associação de runtime. | qualquer credencial autenticada |
POST | /public-api/v1/runtime-bindings/:id/deactivate | Desativa uma associação de runtime. | qualquer credencial autenticada |
POST | /public-api/v1/wp-connect/exchange | Troca um código de transferência da conexão automática do WordPress por credenciais de API. | código de transferência de uso único |
GET | /public-api/v1/model-generator/catalog | Lista os produtos do gerador, as configurações e as revisões de templates visíveis. | embed:session:create |
GET | /public-api/v1/model-generator/models | Lista modelos com descritores de fontes do gerador fixados em revisões específicas para importação. | embed:session:create |
GET | /public-api/v1/model-generator/designer-catalog | Retorna o catálogo de modelos do gerador usado pelo Designer. | embed:session:create |
GET | /public-api/v1/model-generator/projects | Lista os projetos do gerador do proprietário e os disponíveis globalmente. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId | Retorna a revisão mais recente ou selecionada do projeto, o template e o manifesto de arquivos. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | Retorna a revisão mais recente ou selecionada do projeto, o template e o manifesto de arquivos. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId | Baixa um artefato após verificar o acesso ao seu projeto. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template | Retorna um documento de template acessível para a revisão de configuração selecionada. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import | Retorna o pacote de importação do template com os arquivos de dependências. | embed:session:create |
GET | /public-api/v1/model-generator/mannequins | Retorna os dois manequins e os descritores de seus recursos. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets | Lista os recursos das bibliotecas de texturas ou fundos com arquivos importáveis. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets/:assetId | Retorna um recurso de textura ou fundo com seus arquivos importáveis. | embed:session:create |
GET | /public-api/v1/model-generator/public-files/:key | Baixa um arquivo de dependência permitido do gerador. | embed:session:create |