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

Users

Operações relacionadas à consulta de usuários

Operations

Consulta informações de um usuário

Request

Consulta dados detalhados de um usuário a partir do identificador do Aut0.

Security
InternalAuth
Query
userIdstringrequired

Identificador único do usuário (ID Aut0).

Example: userId=auth0|1234567890abcdef12345678
curl -i -X GET \
  'https://api.producao.aprova.com.br/hub-api/users?userId=auth0%2C1234567890abcdef12345678' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Usuário encontrado com sucesso

Bodyapplication/json
personobject

Informações pessoais do usuário

userobject

Informações adicionais do usuário no Aprova

Response
application/json
{
  "person": {
    "id": "auth0|1234567890abcdef12345678",
    "type": "personal",
    "document": "12345678900",
    "email": "usuario.parceiro@exemplo.com",
    "name": "Maria Oliveira",
    "phone": "11999998888",
    "address": "string"
  },
  "user": {
    "role": "Analista",
    "linked_sectors": [ … ],
    "assigned_permissions": [ … ],
    "account_status": "active",
    "account_situation": { … },
    "created_at": "2025-06-01T12:00:00.000Z",
    "last_login": "2025-11-05T19:52:42.883Z",
    "last_registration_update": "2025-10-20T08:15:30.000Z",
    "redirect_to": null
  }
}