Api para consulta de processos finalizados

Visão Geral

A api de listagem de processos finalizados permite recuperar uma lista de processos finalizados com base em um parâmetro de data e hora final e um limite de tamanho de página.

Endpoint

https://corewebapi.asisprojetos.com.br/api/v2/processo/finalizados

Requisição

Método: GET

Parâmetros de Consulta:

dataHoraFim (timestamp):

• Descrição: Data e hora fim do processo no formato timestamp que pode ser utilizado para filtrar os processos finalizados, este parâmetro pode também ser utilizado para efetuar paginações, pois, no response da api será retornado o último timestamp referente à maior data e hora de fim do processo encontrada na consulta. A API irá retornar apenas os processos finalizados após a data e hora especificadas por este valor.
• Valor padrão: Caso não seja passado nenhum valor, será utilizado um valor padrão que é formado pela data e hora do dia anterior.
• Exemplo: Para buscar processos finalizados após 13 de outubro de 2023 às 14:25:39, você pode usar o valor 1696353939000 (timestamp em milissegundos).

tamanhoPagina (inteiro):

• Descrição: Este parâmetro define o limite do tamanho da página, ou seja, quantos resultados de processos finalizados você deseja receber.
• Valor padrão: Caso não seja passado nenhum valor, será utilizado o valor 100 como padrão.
• Exemplo: Se você definir tamanhoPagina como 10, a API irá retornar 10 processos finalizados de uma só vez

Request

Response

• Nome: ultimoTimestamp
• Tipo: texto
• Descrição: Timestamp da maior data e hora fim do processo dentre os processos retornados
• Nome: processos
• Tipo: Long
• Descrição: Lista com os ids dos processos encontrados na consulta

{
    "ultimoTimestamp": 1691607610000,
    "processos": [
        615679237,
        714669280
    ]
}

Api para consulta de processos finalizados por produto

Request

{
    "ultimoTimestamp": 1691607610000,
    "processos": [
        615679237,
        714669280
    ]
}

Baixar Arquivo

Visão Geral

Este endpoint permite que os usuários baixem um arquivo associado a um processo específico.

Endpoint

https://resultadowebapi.asisprojetos.com.br/api/v1/download/processo/{processoId}

Requisição

Método: GET

Parâmetros de Consulta:

processoId (inteiro):

• Descrição: O ID do processo.

Request Headers:

• app-key (string, obrigatório): chave de aplicativo para autenticação.
• account-key (string, obrigatório): chave de conta para autenticação.

Response

• 200 OK: O arquivo foi baixado com sucesso.
• Content-Type: application/octet-stream
• Body: O conteúdo do arquivo.
• 403 Forbidden: Usuário não autorizado para acessar o arquivo ou o tamanho do arquivo excede o tamanho máximo permitido.
• 404 Not Found: O processo ou arquivo não foi encontrado.

Exemplo Request:

Exemplo Response:

• 200 OK:
• Headers: Content-Disposition: inline; filename=example.txt
• Body: (binary file content)
• 403 Forbidden:

{"message": "Usuário não autorizado para acessar o arquivo"}

• 404 Not Found:

{"message": "Processo não encontrado com id 123"}

Baixar arquivo como texto simples

Visão Geral

Este endpoint permite que os usuários baixem o conteúdo de um arquivo associado a um processo específico como texto simples.

Endpoint

https://resultadowebapi.asisprojetos.com.br/api/v1/download/processo/{processoId}/xml
https://resultadowebapi.asisprojetos.com.br/api/v1/download/processo/{processoId}/json

Requisição

Método: GET

Parâmetros de Consulta:

processoId (inteiro):

• Descrição: O ID do processo.

Request Headers:

• app-key (string, obrigatório): chave de aplicativo para autenticação.
• account-key (string, obrigatório): chave de conta para autenticação.

Response

• 200 OK: O conteúdo do arquivo foi baixado com sucesso.
• Content-Type: text/plain
• Body: O conteúdo do arquivo.
• 403 Forbidden: Usuário não autorizado para acessar o arquivo ou o tamanho do arquivo excede o tamanho máximo permitido.
• 404 Not Found: O processo ou arquivo não foi encontrado.

Exemplo Request:

Exemplo Response:

• 200 OK:
• Headers: Content-Type: text/plain
• Body: (file content as plain text)
• 403 Forbidden:

{"message": "Tamanho máximo excedido"}

• 404 Not Found:

{"message": "Processo não encontrado com id 123"}