Assets (Recursos Territoriais) - API Arah
Parte de: API Arah - Lógica de Negócio e Usabilidade
Versão: 2.0
Data: 2025-01-20
📦 Assets (Recursos Territoriais)
TerritoryAssets representam recursos valiosos do território que pertencem ao próprio território (naturais, culturais, comunitários, infraestruturais, simbólicos). TerritoryAssets não são vendáveis e não devem ser tratados como produtos ou serviços. Mídia (foto, vídeo, documento, link) deve ser tratada como registro/evidência associada a um TerritoryAsset, Event ou Post, não como TerritoryAsset em si.
Criar Asset (POST /api/v1/assets)
Descrição: Cria um recurso territorial valioso (ex.: trilha, nascente, ponto cultural, infraestrutura comunitária).
Como usar:
- Exige autenticação
- Body:
territoryId, nome, descrição, tipo,geoAnchors(obrigatório)
Regras de negócio:
- Permissão: Apenas moradores verificados (RESIDENT +
ResidencyVerification != NONE) ou curadores podem criar - Geolocalização: Obrigatória (pelo menos um GeoAnchor)
- Status: Asset é criado como
PENDING(aguarda validação) - Limites: Nome máximo 200 caracteres, descrição máxima 1000 caracteres
- Não vendável: TerritoryAssets não podem ser vendidos ou transferidos via marketplace
Listar Assets (GET /api/v1/assets)
Descrição: Lista assets do território.
Como usar:
- Exige autenticação
- Query params:
territoryId(opcional),assetId(filtro),type(filtro),skip,take(paginação) - Header
X-Session-Idpara identificar território ativo
Regras de negócio:
- Visibilidade: Apenas assets validados (
VALIDATED) são retornados - Filtros:
assetIdetypesão opcionais - Paginação: Padrão 20 itens
Validar Asset (POST /api/v1/assets/{assetId}/validate)
Descrição: Valida um asset (curadoria).
Como usar:
- Exige autenticação
- Path param:
assetId
Regras de negócio:
- Permissão: Apenas curadores (CURATOR) podem validar
- Status: Se validado, status muda para
VALIDATED - Idempotente: Pode validar múltiplas vezes
- Contagem: Assets retornam contagem de validações e percentual
📚 Documentação Relacionada
- Mapa Territorial - Assets aparecem como pins no mapa
- Marketplace - Assets NÃO são vendáveis (diferenciação importante)
- Regras de Visibilidade - Visibilidade de assets
Voltar para: Índice da Documentação da API