Pular para o conteúdo principal
- Referência de endpoints

Referência de endpoints da API

Estes são os endpoints voltados ao cliente na primeira versão da API. Todos os caminhos são relativos à URL base da sua API, que o aplicativo mostra em Configurações → API keys depois que você criar uma chave.

Ativos

MétodoCaminhoFinalidade
POST/assetsImportar uma URL remota como asset.
POST/assets/uploadsIniciar um upload direto.
POST/assets/uploads/{uploadId}/completeFinalizar um upload direto.
GET/assetsListar assets.
GET/PATCH/DELETE/assets/{id}Ler, atualizar ou excluir um asset.

Categorias, mapeamentos, pacotes, links e tags

MétodoCaminhoFinalidade
GET/POST/categoriesListar ou criar categorias planas.
GET/PATCH/DELETE/categories/{id}Ler, renomear ou excluir uma categoria.
GET/POST/mappingsListar ou inserir/atualizar mapeamentos de produtos da Shopify.
GET/PUT/DELETE/mappings/{id}Ler, substituir ou excluir um mapeamento.
GET/POST/packsListar ou criar packs.
GET/DELETE/packs/{id}Ler ou excluir um pack.
GET/POST/linksListar ou criar links. A criação exige um plano pago; limites de visitas e expiração continuam exclusivos do admin.
GET/POST/license-key-tagsListar ou criar tags de chaves de licença.

Pedidos e acesso

MétodoCaminhoFinalidade
GET/orders/{shopify_order_id}Ler o status de download de um pedido.
GET/POST/orders/{shopify_order_id}/assignmentsListar ou criar atribuições no nível do produto.
GET/orders/{shopify_order_id}/assignments/{purchaseId}/download-urlsGerar URLs de download.
POST/orders/{shopify_order_id}/revokeDesativar o acesso.
POST/orders/{shopify_order_id}/restoreRestaurar o acesso.
POST/orders/{shopify_order_id}/grant-downloadsConceder downloads extras.
POST/orders/{shopify_order_id}/resendReenviar o e-mail de entrega.

O endpoint de download-urls retorna 422 withdrawal_consent_required quando a loja tem o consentimento do direito de arrependimento da UE ativado e o pedido ainda não tem um registro de consentimento; as URLs de download são emitidas assim que o cliente consente.

Os endpoints download-urls e resend retornam 409 delivery_not_yet_released quando o produto tem um atraso na entrega do download configurado e os arquivos do comprador ainda não foram liberados. O valor error.details.release_at é o instante ISO 8601 da liberação, e o endpoint grant-downloads libera o pedido antecipadamente.

Saúde e status

MétodoCaminhoFinalidade
GET/healthVerificar a disponibilidade da API.
GET/pingVerificar a autenticação.
GET/jobs/{jobId}Ler o status de um job assíncrono.

Documentação da API

Isto foi útil?

Ainda com dúvidas? Envie um e-mail para admin@alvaapps.com.

Última atualização 2026-06-05