# APIs, modelos e automações documentais

Exemplos REST, modelo XML de aspecto e desenho de regras para classificação documental.

Editora: Arquindex. Revisão: 06/11/2026.

URL canônica: https://www.arquindex.com.br/open-source-documental/alfresco/apis-modelos/

Escopo: Referência técnica; exemplos sujeitos à compatibilidade da versão.

## Resposta direta

Tipos definem a estrutura de um nó. Aspectos acrescentam propriedades e comportamentos reutilizáveis. Use APIs documentadas para integrar aplicações e evite escrita direta nas tabelas internas.

REST oferece recursos próprios do Alfresco; CMIS é uma interface padronizada entre repositórios. Use contas técnicas com permissões proporcionais e mantenha credenciais no servidor de integração.



```text
# URL e usuário ilustrativos. O curl pedirá a senha.
curl --fail --show-error --user usuario_integracao \
  'https://ged.exemplo.com.br/alfresco/api/-default-/public/alfresco/versions/1/nodes/-shared-/children?maxItems=25'
```




```text
# Substituir o UUID e o arquivo. Operação de escrita no destino informado.
curl --fail --show-error --user usuario_integracao \
  -F 'filedata=@documento.pdf;type=application/pdf' \
  -F 'name=documento.pdf' \
  -F 'nodeType=cm:content' \
  'https://ged.exemplo.com.br/alfresco/api/-default-/public/alfresco/versions/1/nodes/UUID_DA_PASTA/children'
```


Exemplos de contrato para adaptar e testar. Não incluem política de repetição ou deduplicação; repetir upload pode criar duplicatas ou conflito.

## Modelo documental e automações possíveis


NecessidadeDesenho de implementaçãoValidação

Título = Tipo DocumentalPropriedade de classificação + comportamento ou ação que atualiza cm:titleDefinir o rótulo desejado e executar ao criar e ao alterar o tipo; evitar recursão.

Dossiê por colaboradorModelo com matrícula/identificador; pasta e permissões criadas por serviçoUsar chave estável, tratar homônimos e mudança de nome; evitar duplicação.

Ativo/inativo e demissãoAspecto com estado e data; regras de acesso e pesquisaDefinir transições e quem pode alterar os campos.

TemporalidadeClasse, evento inicial, prazo e destinação em modelo + serviço de cálculoValidar tabela aplicável e eventos; expurgo deve ter processo de autorização.

OCR e PDF pesquisávelPipeline de captura/qualidade antes de publicar ou serviço assíncronoPreservar relação com original e medir precisão; OCR não é assinatura.

Assinatura em loteServiço de assinatura controlado e retorno de arquivo/evidênciasControlar identidade, segredo e uso do certificado; validar a assinatura resultante.

ERP / CRM / portalAdaptador REST/CMIS e fila de integraçãoIdempotência, auditoria, isolamento por cliente e recuperação de falhas.

Activiti / CamundaIntegração de processos por APIs/eventos conforme desenhoSão componentes com ciclos próprios; não basta instalar um AMP para trocar motor.

As soluções da tabela são propostas de engenharia, não funções já instaladas neste portal ou em seu servidor. A auditoria do Alfresco deve ser configurada para os eventos necessários; não presuma que toda leitura/alteração já esteja registrada.

Fontes: [API Explorer ↗](https://api-explorer.alfresco.com/api-explorer/) · [CMIS API ↗](https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/25.1/Alfresco-Content-Services/Develop/Reference/CMIS-API)

## Exemplo de aspecto documental

Modelo XML didático para empacotar em uma extensão compatível. O namespace identifica este exemplo da Arquindex; não depende de existir uma página web nesse endereço.



```text
<?xml version="1.0" encoding="UTF-8"?>
<model name="arq:documental" xmlns="http://www.alfresco.org/model/dictionary/1.0">
  <description>Exemplo didático de classificação documental</description>
  <author>Arquindex</author><version>1.0</version>
  <imports>
    <import uri="http://www.alfresco.org/model/dictionary/1.0" prefix="d"/>
    <import uri="http://www.alfresco.org/model/content/1.0" prefix="cm"/>
  </imports>
  <namespaces><namespace uri="https://arquindex.com.br/model/documental/1.0" prefix="arq"/></namespaces>
  <aspects>
    <aspect name="arq:classificacao">
      <title>Classificação documental</title>
      <properties><property name="arq:tipoDocumental">
        <title>Tipo documental</title><type>d:text</type>
      </property></properties>
    </aspect>
  </aspects>
</model>
```


O XML precisa de registro/bootstrap no módulo, build e teste de implantação. Depois de carregar o modelo, pode-se aplicar o aspecto aos documentos. O modelo sozinho não cria telas de edição nem sincroniza o título.