API Explorer
Interface Swagger UI para explorar e testar as APIs REST disponíveis na plataforma HTF Apps.
URL de acesso: https://{servidor}/api-explorer/
APIs disponíveis
O API Explorer agrupa duas categorias de definições: as APIs padrão do Alfresco Community e as APIs customizadas do HTF Apps.
APIs Alfresco
| Definição | Descrição |
|---|---|
| Alfresco Core REST API | Operações sobre nós, conteúdo, permissões e metadados do repositório |
| Alfresco Search REST API | Busca AFTS/CMIS no repositório |
| Alfresco Search SQL REST API | Busca via SQL no Solr |
| Alfresco Model REST API | Gerenciamento de modelos de dados |
| Alfresco Workflow REST API | Workflows Activiti nativos do Alfresco |
| Alfresco Discovery REST API | Informações de versão e capacidades da instalação |
| Alfresco GS Core REST API | Governance Services — registros e categorias |
APIs HTF Apps
| Definição | Base Path | Descrição |
|---|---|---|
| HTF Apps ToolKit REST API | /alfresco/s/htf/toolkit | Ações sobre documentos e membros do repositório |
| HTF Apps Process REST API | /process | Inicialização e consulta de workflows |
| HTF Apps Capture REST API | /capture | Upload externo de documentos para instâncias de captura |
| HTF Apps GS Extended REST API | /alfresco/s/api/rma | Extensões de Governance Services — eventos e ações sobre registros |
HTF Apps ToolKit REST API
Endpoints expostos em /alfresco/s/htf/toolkit:
| Endpoint | Descrição |
|---|---|
POST /a1sign | Assina documento com certificado A1 usando perfil do WFDesigner |
POST /safeidsign | Assina documento via SafeID |
POST /createpropertiessummary | Gera resumo de propriedades do nó |
POST /docdeleteversionhistory | Remove histórico de versões do documento |
GET /getpages | Retorna número de páginas de um PDF |
POST /pdfmergeall | Une todos os PDFs filhos de uma pasta |
POST /updateproperties | Atualiza metadados de um nó |
POST /checkisrecord | Verifica se o nó é um registro (Governance Services) |
GET /getmemberofgroups | Retorna os usuários de um grupo |
GET /getmemberofsites | Retorna os usuários de um site |
HTF Apps Process REST API
Endpoints expostos em /process:
| Endpoint | Descrição |
|---|---|
POST /getlastdefinition | Retorna o ID da última definição de um workflow pelo nome |
POST /startinstance | Inicia uma instância de workflow |
HTF Apps Capture REST API
Endpoints expostos em /capture:
| Endpoint | Descrição |
|---|---|
POST /externalupload | Envia um arquivo para processamento em uma instância de captura. Requer apikey (código de instalação), site, modelo XML e o arquivo |
HTF Apps GS Extended REST API
Endpoints expostos em /alfresco/s/api/rma:
| Endpoint | Descrição |
|---|---|
GET /admin/rmevents | Consulta eventos de Records Management |
POST /actions/ExecutionQueue | Executa uma ação de Records Management |
Autenticação
Todas as APIs HTF Apps usam HTTP Basic Authentication com as credenciais do Alfresco. A API de Capture usa apikey (código de instalação) como parâmetro de formulário.