Skip to content

Hub API - Aprova

O Hub API é uma plataforma de abstração de APIs projetada para padronizar e simplificar a integração de sistemas de parceiros terceiros com o Aprova. O principal objetivo é criar um ponto de entrada único e seguro para as funcionalidades do Aprova. Utilizamos um sistema de autenticação robusto para garantir que o uso dos nossos serviços por terceiros seja seguro, controlado e intuitivo. Isso facilita o trabalho de desenvolvedores externos e reduz a complexidade da integração.

Como Obter sua Chave API

Para começar a usar o Hub API, siga os passos abaixo para habilitar a funcionalidade e gerar suas chaves de acesso:

Passo 1: Ative a Permissão de Administrador

  • Navegue até: Outros > Administração Geral > Permissões > Todas as Permissões
  • Ative a permissão hubapi:admin
  • Vincule essa permissão a um grupo de usuários administradores
  • Saia do sistema e entre novamente

Passo 2: Acesse o Gerenciador de Chaves

  • Após ativar a permissão, um novo menu aparecerá
  • Navegue até: Outros > Administração Geral > Gerenciar Ambiente > Chaves API - Hub API

Passo 3: Crie sua Chave API

  • Clique em Criar Chave API
  • Defina um nome único para identificar a chave
  • Copie e salve a chave exibida imediatamente

IMPORTANTE: A chave API será exibida por completo apenas uma vez. Após sair da tela, por motivos de segurança, a chave completa não será mostrada novamente. Certifique-se de armazená-la em um local seguro.

Download OpenAPI description
aprovahubapi.json
aprovahubapi.yaml
Overview
Aprova
suporte@aprova.com.br
Languages
Servers
https://api.producao.aprova.com.br

Process

Operações relacionadas à consulta de processos

Operations

Dispatch

Operações relacionadas à criação e edição de despachos

Operations

Type

Operações relacionadas a assuntos (types)

Operations

Cria um novo assunto

Request

Cria um novo assunto associado à cidade do tenant identificado pela API Key. Para keys com permissionLevel support, o campo cityId deve ser informado no body.

Security
InternalAuth
Bodyapplication/jsonrequired
modelonumberrequired

Modelo do assunto

Example: 0
cidadestring

Slug da cidade (ex. saopaulosp)

Example: "saopaulosp"
cityIdnumber

ID numérico da cidade. Obrigatório para keys support; ignorado para tenant (extraído automaticamente da API Key).

Example: 138
curl -i -X POST \
  https://api.producao.aprova.com.br/hub-api/type/create \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "modelo": 0,
    "cidade": "saopaulosp"
  }'

Responses

Assunto criado com sucesso

Bodyapplication/json
_idstring
Example: "69aae29b8f070e4432a63036"
configobject
formArray of objects
createdAtstring
Example: "2026-01-15T10:30:00.000Z"
Response
application/json
{
  "_id": "69aae29b8f070e4432a63036",
  "config": {
    "title": "Titulo novo assunto",
    "descricao": "Descrição",
    "cidade": "saopaulosp",
    "approveActionText": "Deferir",
    "markdown": "Acesse a aba Resumo para verificar o andamento do seu processo",
    "sigla": "NEW",
    "templates": [],
    "form_tramites": [],
    "fluxograma": { … },
    "tenance": "Geral",
    "devolverAoUltimo": true
  },
  "form": [
    { … }
  ],
  "createdAt": "2026-03-06T00:00:00.000Z"
}

Atualiza um assunto com validação

Request

Atualiza os campos config e/ou form de um assunto existente. Apenas esses dois campos são aceitos no body — qualquer outro campo será rejeitado com erro 400.

Security
InternalAuth
Path
typeIdstringrequired

ID MongoDB do assunto

Example: 69aae29b8f070e4432a63036
Bodyapplication/jsonrequired
configobject

Configurações do assunto a serem atualizadas

formArray of objects

Definição dos campos do formulário a ser atualizada

curl -i -X PATCH \
  https://api.producao.aprova.com.br/hub-api/type/edit/69aae29b8f070e4432a63036 \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "config": {
      "devolverAoUltimo": true,
      "title": "Titulo novo assunto",
      "descricao": "Descrição",
      "cidade": "saopaulosp",
      "approveActionText": "Deferir",
      "markdown": "Acesse a aba Resumo para verificar o andamento do seu processo",
      "sigla": "NEW",
      "templates": [],
      "form_tramites": [],
      "fluxograma": {
        "fields": []
      }
    }
  }'

Responses

Assunto atualizado com sucesso

Bodyapplication/json
_idstring
Example: "69aae29b8f070e4432a63036"
configobject
formArray of objects
Response
application/json
{
  "_id": "69aae29b8f070e4432a63036",
  "config": {
    "devolverAoUltimo": true,
    "title": "Titulo novo assunto",
    "descricao": "Descrição",
    "cidade": "saopaulosp",
    "approveActionText": "Deferir",
    "sigla": "NEW",
    "tenance": "Geral"
  },
  "form": [
    { … }
  ]
}

Template

Operações relacionadas a templates de processos

Operations

Users

Operações relacionadas à consulta de usuários

Operations