Conta
- OBTER /v1/account - verificar a autenticação, ver o nível
- OBTER /v1/account/usage - utilização do período atual
- PUT /v1/account/webhook - definir o URL do webhook + eventos
PROGRAMADORES - COLECÇÃO DE CARTEIROS
Importar a coleção. Aceder ao API em cinco minutos.
Coleção Postman pré-construída com exemplos de trabalho para cada ponto final REST do Fabrixa. Insira sua chave API, clique nas solicitações, veja as respostas reais em relação ao a caixa de areia antes de escrever uma única linha de código de integração. Rastreado através de versões - a coleção é atualizada quando o API o faz.
POSTMAN v10+ - SANDBOX + PRODUCTION ENVS - ATUALIZADO A CADA LANÇAMENTO DO API
O QUE HÁ NA COLECÇÃO
Cada ponto de extremidade, com exemplos de cargas úteis.
Organizado em pastas por recurso: Conta, Produtos, Pedidos, Webhooks, Editor SDK. Cada pedido vem com um exemplo de corpo trabalhado, cabeçalhos pré-definidos e um exemplo de resposta bem sucedida guardada - para que possa pré-visualizar a forma da resposta antes de disparar.
Produtos
- OBTER /v1/produtos - listar / paginar / filtrar
- OBTER /v1/products/:id - pormenor completo do produto
- OBTER /v1/products/:id/pricing - pré-visualização do nível de volume
Encomendas
- POSTAR /v1/orders - criar (com chave de idempotência)
- OBTER /v1/encomendas - lista / paginar
- OBTER /v1/orders/:id - estado, acompanhamento, ciclo de vida
- DEL /v1/orders/:id - cancelar antes do bloqueio da produção
Webhooks e SDK
- POSTAR /v1/webhooks/test - ativar evento de amostra
- OBTER /v1/webhooks/events - lista de tipos de eventos
- OBTER /v1/sdk/keys - chaves SDK públicas + secretas
IMPORTAR EM 30 SEGUNDOS
Carteiro → Ficheiro → Importar → Ligação → colar URL.
01
IMPORTAR A COLECÇÃO
Em Postman: Ficheiro → Importar → Ligação. Cole o URL JSON do botão de transferência acima. O Postman vai buscar e adiciona a coleção ao seu espaço de trabalho.
02
IMPORTAR O AMBIENTE
Mesmo fluxo, ambiente URL: .../fabrixa-api.postman_environment.json. Configura a variável scaffolding (URL de base, marcador de chave API).
03
DEFINIR A SUA CHAVE API
Abrir o ambiente importado, preencher FABRIXA_API_KEY com sua chave de sandbox. Mude para o ambiente de produção quando estiver pronto para enviar.
VARIÁVEIS DE AMBIENTE
O que está no ficheiro env.
fabrixa.postman_environment.json
# Ambiente de caixa de areia { "FABRIXA_BASE_URL": "https://sandbox.api.fabrixa.com/v1", "FABRIXA_API_KEY": "sk_sandbox_yourKeyHere", "FABRIXA_PUBLIC_KEY": "pk_sandbox_yourPublicKey", "FABRIXA_WEBHOOK_URL": "https://your-tunnel.ngrok.io/webhook" } # Ambiente de produção (ficheiro separado) { "FABRIXA_BASE_URL": "https://api.fabrixa.com/v1", "FABRIXA_API_KEY": "sk_live_yourKeyHere", "FABRIXA_PUBLIC_KEY": "pk_live_yourPublicKey", "FABRIXA_WEBHOOK_URL": "https://api.yourbrand.com/webhook" }
AUTH PRÉ-CONFIGURADO
Token portador aplicado ao nível da coleção.
A coleção Autorização está configurado para herdar a chave API do ambiente ativo. Todos os pedidos dentro da coleção a recebem automaticamente - sem configuração de cabeçalho por pedido.
Mudar de sandbox para produção é um clique no menu suspenso de ambiente. A mesma coleção, chaves diferentes, URL de base diferente. Não são necessárias alterações de código.
EXEMPLOS PRÁTICOS
Cada pedido é enviado com um corpo de amostra e uma resposta guardada.
A coleção não é apenas stubs de URL - cada pedido vem com um corpo de exemplo para que você possa clicar em Enviar e ver dados reais. As respostas de exemplo salvas são visíveis no painel Exemplos para referência offline.
CRIAR ORDEM
POST /v1/encomendas
Exemplo de corpo para uma encomenda de T-shirt de 2 unidades com URL de arte personalizada, endereço do destinatário e chave de idempotência. Clique em Enviar para ver uma resposta 201 Criado com order_id.
LISTA DE PRODUTOS
GET /v1/produtos
Consulta pré-filtrada para a categoria de vestuário. Devolve o catálogo página a página com tamanhos, GSM, prazo de entrega e nível de preços por SKU.
ACCIONAMENTO DO WEBHOOK
POST /v1/webhooks/test
Dispare manualmente um evento de webhook de amostra para o seu URL registado. Útil para depurar manipuladores de webhook sem fazer um pedido real.
VERIFICAR A UTILIZAÇÃO
GET /v1/account/usage
Utilização atual do período de faturação, estado de progressão dos níveis, volume projetado para o final do período. Útil para o planeamento da capacidade antes de uma grande queda.
CANCELAR ORDEM
DELETE /v1/orders/:id
Cancela uma encomenda antes de esta bloquear a produção (normalmente, no prazo de 24 horas após a colocação). Devolve 409 se a produção já tiver começado - a chave de idempotência trata de novas tentativas.
PREVISÃO DE PREÇOS
GET /v1/products/:id/pricing
Pré-visualização do preço unitário nos níveis de volume para um determinado SKU. Útil para mostrar aos clientes a poupança por unidade à medida que aumentam a quantidade encomendada.
VERSÃO
A coleção é actualizada quando o API o faz.
Cada versão do Fabrixa API envia uma coleção atualizada do Postman no mesmo URL. Reimporte para pegar novos endpoints e exemplos de payloads - as requisições existentes existentes na sua versão salva permanecem funcionando até que esse ponto final seja realmente obsoleto.
01
URL ESTÁVEL
O URL JSON da coleção é permanente. A reimportação puxa a última versão. A URL nunca muda entre as versões do API.
02
REFERÊNCIA DO REGISTO DE ALTERAÇÕES
Ver Registo de alterações para as notas da versão API correspondentes - o que foi movido, o que foi adicionado, o que está obsoleto.
03
POLÍTICA DE DEPRECIAÇÃO
Os pontos de extremidade têm uma janela de depreciação de 12 meses. A coleção assinala os pedidos obsoletos na descrição, para que seja difícil não os ver antes de as coisas avariarem.
DESCARREGAR E INICIAR
Pegue na coleção. Faça o seu primeiro pedido.
Importar URL: https://www.fabrixa.com/wp-content/themes/brighthub-fabrixa/assets/downloads/fabrixa-api.postman_collection.json