Beta · acesso sob solicitação

A API do aprumo: seus fluxos dentro dos seus sistemas.

Q: O que dá para fazer com a API do aprumo?

Duas coisas. Leitura: listar fluxos, consultar o estado de uma instância e suas tarefas, e ler os registros das suas bases de dados — para alimentar ERP, BI ou data warehouse. Escrita: iniciar um fluxo, avançar uma tarefa e criar ou atualizar registros a partir de um sistema que você já usa, sem ninguém reabrir o aprumo para redigitar.

Consulte fluxos, o andamento de cada pedido e as bases de dados da sua conta — e abra pedidos e avance aprovações a partir do sistema que sua empresa já usa. Autenticação por chave, com escopo por recurso.

Solicitar acesso Ver a documentação

REST em api.aprumo.pro/api/v1 · Bearer token · escopo por recurso.

Por que isso importa

Uma ferramenta que não deixa você sair não é controle. É dependência.

O dado é seu

O que entra no aprumo sai por chamada de API: fluxos, instâncias, tarefas e as bases de dados da conta. Sem exportação manual, sem pedir arquivo para o suporte.

Sem redigitação

O pedido aprovado no aprumo vira lançamento no ERP sem ninguém copiar campo a campo. Uma digitação a menos é um erro a menos na conciliação.

O BI enxerga o processo

Tempo de aprovação, gargalo por etapa, gasto por centro de custo. Números que hoje ninguém mede porque vivem numa planilha.

O que a API faz hoje

Ler, escrever e autenticar. Nada além disso — por enquanto.

A referência completa de endpoints, parâmetros e respostas fica na documentação. Aqui está o resumo do que já está de pé.

Leitura

Consulte fluxos, o estado de cada instância, as tarefas e os registros das suas bases. É o caminho para alimentar ERP, BI ou data warehouse com o que acontece nos seus fluxos.

Consultar o andamento de um pedido

curl https://api.aprumo.pro/api/v1/instances/$INSTANCE_ID \
  -H "Authorization: Bearer $APRUMO_API_KEY"

Devolve o estado da instância e as tarefas ativas. Escopo instances:read. As listagens são paginadas.

Escrita

Crie registros e movimente aprovações a partir de outro sistema. O fluxo continua valendo: o que entra pela API passa pelas mesmas regras e pela mesma trilha do que entra pela tela.

Abrir um pedido a partir do seu sistema

curl -X POST https://api.aprumo.pro/api/v1/workflows/$WORKFLOW_ID/start \
  -H "Authorization: Bearer $APRUMO_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"values": {"cnpj": "12.345.678/0001-90"}, "priority": "Alta"}'

Escopo workflows:start. O Idempotency-Key garante que uma chamada repetida não abra o pedido duas vezes.

Autenticação

Toda chamada é autenticada por uma chave de API que você gera na sua conta, com escopos — a integração recebe só a permissão de que precisa, e não uma cópia dos seus poderes de administrador.

Toda chamada

-H "Authorization: Bearer $APRUMO_API_KEY"

Cada endpoint exige um escopo próprio — workflows:read, workflows:start, instances:read, tasks:write, entre outros. A chave carrega só os escopos que você conceder a ela.

Ver a documentação completa →

Cenários

O que dá para construir com ela.

Aprovação → ERP

A aprovação de compra sai do aprumo e entra no ERP como lançamento, sem redigitação.

Fluxos → BI

Painéis de gasto e de tempo de ciclo alimentados direto da fonte — inclusive a prestação de contas.

Sistema interno → aprumo

O portal que sua equipe de TI já mantém abre requisições no aprumo por chamada de API.

Transparência

O que "beta" significa aqui.

Ela funciona

Não é protótipo nem promessa de roadmap. A API está de pé e o acesso é liberado sob solicitação, para acompanharmos as primeiras integrações de perto.

Contratos podem mudar

Enquanto estiver em beta, campos e respostas ainda podem mudar. Avisamos antes de qualquer mudança que quebre integração já existente — você não descobre pelo erro em produção.

Webhooks ainda não

Hoje a integração é por chamada à API. Notificação de evento em tempo real está no radar, sem data. Preferimos dizer o que existe a listar o que não existe.

Perguntas frequentes

Dúvidas de quem vai integrar.

O que dá para fazer com a API do aprumo?

Duas coisas. Leitura: listar fluxos, consultar o estado de uma instância e suas tarefas, e ler os registros das suas bases de dados — para alimentar ERP, BI ou data warehouse. Escrita: iniciar um fluxo, avançar uma tarefa e criar ou atualizar registros a partir de um sistema que você já usa, sem ninguém reabrir o aprumo para redigitar.

Como funciona a autenticação?

Por chave de API. Você gera a chave na sua conta, com escopos, e a envia no cabeçalho de autorização de cada chamada — a integração recebe só a permissão de que precisa.

A API tem webhooks?

Ainda não. Hoje a integração é feita por chamadas à API — leitura e escrita. Notificação de eventos em tempo real está no radar, mas não prometemos data.

O que significa a API estar em beta?

Significa que ela funciona e já pode ser usada, mas o acesso é liberado sob solicitação e os contratos ainda podem mudar. Avisamos antes de qualquer mudança que quebre integração existente. Se você precisa de estabilidade absoluta agora, vale esperar a versão estável.

Como consigo acesso?

Solicitando acesso ao beta. Priorizamos quem descreve o caso de integração — qual sistema vai conversar com o aprumo e para quê.

Conte o que você quer integrar.

As vagas do beta são liberadas por ordem de caso de uso. Descreva qual sistema vai conversar com o aprumo — é o que usamos para priorizar a fila.

Solicitar acesso