Endpoints
GET /api/workspace/{workspaceId}/settings/pipeline
PUT /api/workspace/{workspaceId}/settings/pipeline
Parâmetros de path
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
workspaceId | string | Sim | Seu ID de workspace |
GET — Ler configurações
Retorna a configuração atual do pipeline para o workspace.
Resposta
{
"silverMappings": [
{
"sourceField": "product_name",
"targetField": "title",
"transform": "trim"
}
],
"goldWeights": {
"identity": 20,
"taxonomy": 15,
"content": 25,
"media": 20,
"pricing": 10,
"attributes": 5,
"seo": 5
},
"autoTriggerSilver": false,
"autoTriggerGold": false,
"previewMode": false,
"updatedAt": "2026-03-15T10:30:00Z"
}
PUT — Atualizar configurações
Atualiza a configuração do pipeline. Todos os campos são opcionais — inclua apenas os campos que deseja alterar.
Objeto FieldMapping
| Campo | Tipo | Obrigatório | Descrição |
|---|
sourceField | string | Sim | Nome da coluna de origem como aparece no arquivo de importação |
targetField | string | Sim | Campo de destino no schema do Alana |
transform | string | Não | Transformação opcional: "trim", "uppercase", "lowercase", "prefix:X", "suffix:X" |
Flags de comportamento
| Campo | Tipo | Padrão | Descrição |
|---|
autoTriggerSilver | boolean | false | Executar Silver automaticamente após cada ingestão Bronze |
autoTriggerGold | boolean | false | Executar Gold automaticamente após Silver concluir |
previewMode | boolean | false | Simular mudanças no pipeline sem gravar nos produtos |
Todos os valores de goldWeights devem somar exatamente 100. Um erro 422 é retornado se a soma estiver incorreta.
Exemplos
# Ler configurações atuais
curl "https://app.alana.shopping/api/workspace/ws_123/settings/pipeline" \
-H "Authorization: Bearer sk_live_sua_chave_api"
# Atualizar mapeamentos Silver
curl -X PUT "https://app.alana.shopping/api/workspace/ws_123/settings/pipeline" \
-H "Authorization: Bearer sk_live_sua_chave_api" \
-H "Content-Type: application/json" \
-d '{
"silverMappings": [
{ "sourceField": "product_name", "targetField": "title", "transform": "trim" },
{ "sourceField": "item_code", "targetField": "sku" }
]
}'
Respostas de erro
| Status HTTP | Código | Descrição |
|---|
| 403 | INSUFFICIENT_PERMISSIONS | Chave API sem settings:write |
| 404 | WORKSPACE_NOT_FOUND | ID de workspace não encontrado |
| 422 | WEIGHTS_SUM_INVALID | Pesos Gold não somam 100 |
| 422 | VALIDATION_ERROR | Valor de mapeamento de campo ou transform inválido |
