Referência da API

Esta primeira referência cobre somente endpoints externos confirmados no backend. APIs usadas pela interface administrativa não são automaticamente tratadas como API pública.

Base URL

Substitua https://api.example.com pelo domínio da sua instalação. A API externa versionada começa em:

/api/external/v1

Autenticação

Envie a chave externa no header X-Api-Key.

X-Api-Key: sua-chave

Nunca exponha uma API key no navegador

Faça chamadas a partir de um serviço controlado e armazene a chave em um gerenciador de segredos.

Listar processos

GET/api/external/v1/tasks

Busca processos acessíveis à chave externa.

Query parameters

Campo	Tipo	Obrigatório	Descrição
searchBusca	STRING	Não	Texto usado para filtrar processos.
sizeQuantidade	INTEGER	Não	Máximo de 50 resultados; padrão 50.

curl --request GET \
  --url https://api.example.com/api/external/v1/tasks \
  --header 'X-Api-Key: $IBPMS_API_KEY'

Criar processo

POST/api/external/v1/tasks

Cria um processo a partir do payload aceito pelo tipo configurado.

201Processo criado

Retorna a representação do processo criado.

Consultar processo

GET/api/external/v1/tasks/{taskId}

Retorna a visão atual de um processo.

Campo	Tipo	Obrigatório	Descrição
taskIdtaskId	INTEGER	Sim	Identificador do processo.

Alterar situação

PUT/api/external/v1/tasks/{taskId}/situation

Move o processo para outra situação válida.

Documentos do processo

GET/api/external/v1/tasks/{taskId}/documents

Lista documentos associados ao processo.

POST/api/external/v1/tasks/{taskId}/documents

Envia um documento usando multipart/form-data.

Registros de bases internas

GET/api/external/v1/bases/{baseId}/records

Consulta registros de uma base interna.

POST/api/external/v1/bases/{baseId}/records

Cria um registro em uma base interna.

PUT/api/external/v1/bases/{baseId}/records/{rowId}

Atualiza um registro existente.

DELETE/api/external/v1/bases/{baseId}/records/{rowId}

Remove um registro existente.

Erros e limites

• trate respostas 401 e 403 sem registrar a API key;
• valide o corpo de respostas 4xx antes de tentar novamente;
• não repita automaticamente operações de criação sem uma estratégia de idempotência;
• limites comerciais e cotas podem variar conforme o plano e o ambiente.

OpenAPI

O portal está preparado para receber uma especificação OpenAPI como fonte de dados futura. Nesta entrega, nenhuma especificação é inferida nem gerada a partir dos controllers.