API - Visão geral

API - Arquivos, fontes e moedas

Obtenha arquivos públicos e protegidos, a lista de fontes e as moedas disponíveis.

Visão geral dos endpoints

MétodoEndpointDescriçãoAcesso
GET/public-api/v1/file/public/products/:productId/:sizeRetorna 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/:keyRetorna um arquivo protegido pela chave de armazenamento.URL assinada ou files:read
GET/public-api/v1/fontsRetorna todas as fontes disponíveis.público
GET/public-api/v1/currenciesRetorna todas as moedas.público

Arquivos, fontes e moedas

Os arquivos públicos de prévia são compatíveis com navegadores. Os arquivos protegidos exigem uma URL assinada ou uma credencial de API com files:read. Fontes e moedas são endpoints públicos de leitura.

EndpointAcessoDetalhes
/file/public/products/:productId/small.pngpúblicoPrévia pequena do produto.
/file/public/products/:productId/medium.pngpúblicoPrévia média do produto.
/file/public/products/:productId/big.pngpúblicoPrévia grande do produto.
/file/protected/:keyURL assinada ou files:readArquivo protegido no armazenamento de objetos.
/fontspúblicoArray de registros de fontes.
/currenciespúblicoArray de registros de moedas.

Exemplo de solicitação (fetch)

const publicPreview = await fetch(
  'https://alterproduct.com/public-api/v1/file/public/products/4/medium.png'
);

const protectedFile = await fetch(
  'https://alterproduct.com/public-api/v1/file/protected/user_34/381/design/mockup-large.webp',
  {
    headers: authHeaders
  }
);

const fonts = await fetch('https://alterproduct.com/public-api/v1/fonts').then((res) => res.json());
const currencies = await fetch('https://alterproduct.com/public-api/v1/currencies').then((res) => res.json());

Exemplo de resposta

[
  {
    "id": 1,
    "family": "Inter",
    "source": "google",
    "category": "sans-serif",
    "variants": ["regular", "600", "700"],
    "subsets": ["latin"],
    "version": "v19",
    "menu": "Inter",
    "files": {
      "regular": "https://..."
    }
  }
]
[
  {
    "id": 1,
    "code": "EUR",
    "name": "Euro",
    "symbol": "€",
    "decimalPlaces": 2
  }
]