Domínio Web - Importação .TXT

Endpoints da WebApiAlcance para registrar e acompanhar os processamentos de importação de arquivos .TXT para o Domínio Web (Thomson Reuters). Cada registro guarda o vínculo com o usuário e o cliente, o arquivo processado, a data do processamento, o status e detalhes adicionais. Cobrem criação, listagem geral, detalhamento por ID, atualização e exclusão.

Todos os endpoints exigem autenticação. Veja Autenticação para o fluxo de API Key. O Swagger oficial está em api.contabilidadealcance.com.br/docs.

Base path

/api/v1/dominio-web

Escopos necessários

dominio_web:read - listagem geral e detalhamento por ID
dominio_web:write - criação, atualização e exclusão

O escopo é derivado da rota: o prefixo /dominio-web vira o recurso dominio_web (hífen → underscore), e o método HTTP define a ação (read para GET, write para POST/PUT/DELETE).

Endpoints

`POST /dominio-web/`

Registra um novo processamento de importação de arquivo .TXT para o Domínio Web. Os dados vão no corpo da requisição.

Parâmetros

Este endpoint não recebe parâmetros de rota ou query - os dados vão no corpo da requisição (DominioDataCreate). Campos obrigatórios: usuario_id, cliente_id, arquivo, data_processamento e status; detalhes é opcional.

Request

{
  "usuario_id": 7,
  "cliente_id": 1234,
  "arquivo": "movimento_2026_06.txt",
  "data_processamento": "2026-07-03T14:22:10",
  "status": "concluido",
  "detalhes": "Importação concluída sem inconsistências."
}

Response 201 Created

{
  "success": true,
  "message": "Registro criado com sucesso",
  "data": {
    "id": 42,
    "usuario_id": 7,
    "cliente_id": 1234,
    "arquivo": "movimento_2026_06.txt",
    "data_processamento": "2026-07-03T14:22:10",
    "status": "concluido",
    "detalhes": "Importação concluída sem inconsistências."
  }
}

Em caso de falha, retorna o envelope de erro { "success": false, "message": "Erro ao registrar conversão", "details": "..." }. Escopo: dominio_web:write

`GET /dominio-web/`

Lista todos os processamentos registrados do Domínio Web.

Parâmetros

Este endpoint não recebe parâmetros de rota ou query.

Request

Sem corpo de requisição.

Response 200 OK

{
  "success": true,
  "message": "Lista recuperada com sucesso",
  "data": [
    {
      "id": 42,
      "usuario_id": 7,
      "cliente_id": 1234,
      "arquivo": "movimento_2026_06.txt",
      "data_processamento": "2026-07-03T14:22:10",
      "status": "concluido",
      "detalhes": "Importação concluída sem inconsistências."
    }
  ]
}

Quando não há registros, a API responde com o envelope de erro { "success": false, "message": "Nenhum registro encontrado" }. Escopo: dominio_web:read

`GET /dominio-web/{id}`

Detalha um processamento pelo ID inteiro.

Parâmetros

Parâmetro	Tipo	Local	Obrigatório	Descrição
`id`	`int`	path	sim	ID interno do registro de processamento.

Request

Sem corpo de requisição.

Response 200 OK

{
  "success": true,
  "message": "Registro encontrado",
  "data": {
    "id": 42,
    "usuario_id": 7,
    "cliente_id": 1234,
    "arquivo": "movimento_2026_06.txt",
    "data_processamento": "2026-07-03T14:22:10",
    "status": "concluido",
    "detalhes": "Importação concluída sem inconsistências."
  }
}

Quando não encontrado, retorna { "success": false, "message": "Registro não encontrado" }. Escopo: dominio_web:read

`PUT /dominio-web/{id}`

Atualiza um processamento existente. O corpo é um DominioDataUpdate com campos parciais - somente o que vier preenchido é considerado.

Parâmetros

Parâmetro	Tipo	Local	Obrigatório	Descrição
`id`	`int`	path	sim	ID do registro de processamento.

Request (DominioDataUpdate - todos os campos opcionais)

{
  "status": "erro",
  "detalhes": "Falha ao importar a linha 128 do arquivo."
}

Response 200 OK

{
  "success": true,
  "message": "Registro atualizado com sucesso",
  "data": {
    "id": 42,
    "usuario_id": 7,
    "cliente_id": 1234,
    "arquivo": "movimento_2026_06.txt",
    "data_processamento": "2026-07-03T14:22:10",
    "status": "erro",
    "detalhes": "Falha ao importar a linha 128 do arquivo."
  }
}

Quando não encontrado, retorna { "success": false, "message": "Registro não encontrado para atualização" }. Escopo: dominio_web:write

`DELETE /dominio-web/{id}`

Remove um registro de processamento do Domínio Web pelo ID.

Parâmetros

Parâmetro	Tipo	Local	Obrigatório	Descrição
`id`	`int`	path	sim	ID do registro de processamento.

Request

Sem corpo de requisição.

Response 200 OK

{
  "success": true,
  "message": "Registro excluído com sucesso",
  "data": null
}

Quando não encontrado, retorna { "success": false, "message": "Registro não encontrado para exclusão" }. Escopo: dominio_web:write

Schemas

`DominioDataCreate`

Campo	Tipo	Obrigatório	Observações
`usuario_id`	`int`	sim	ID do usuário responsável pelo processamento.
`cliente_id`	`int`	sim	ID do cliente ao qual o arquivo pertence.
`arquivo`	`str`	sim	Nome/identificação do arquivo `.TXT` processado.
`data_processamento`	`datetime`	sim	Data e hora do processamento.
`status`	`str`	sim	Situação do processamento (ex.: `concluido`, `erro`).
`detalhes`	`str`	não	Observações ou mensagem adicional sobre o processamento.

`DominioDataUpdate`

Todos os campos são opcionais; apenas os enviados são considerados na atualização.

Campo	Tipo	Observações
`usuario_id`	`int`	Novo usuário responsável.
`cliente_id`	`int`	Novo cliente vinculado.
`arquivo`	`str`	Novo nome/identificação do arquivo.
`data_processamento`	`datetime`	Nova data e hora do processamento.
`status`	`str`	Nova situação do processamento.
`detalhes`	`str`	Novas observações sobre o processamento.

`DominioDataOut`

Campo	Tipo	Notas
`id`	`int`	Identificador do registro de processamento.
`usuario_id`	`int`	Usuário responsável pelo processamento.
`cliente_id`	`int`	Cliente vinculado ao arquivo.
`arquivo`	`str`	Arquivo `.TXT` processado.
`data_processamento`	`datetime`	Data e hora do processamento.
`status`	`str`	Situação do processamento.
`detalhes`	`str`	Observações adicionais.

Notas

Toda resposta segue o envelope { success, message, data } (ou { success: false, message, details } em erro).
GET /dominio-web/ e GET /dominio-web/{id} tratam a ausência de registros como erro de negócio (envelope com success: false), e não como lista vazia - atente-se a isso ao integrar.
Os campos usuario_id, cliente_id, arquivo, data_processamento e status são obrigatórios na criação; detalhes é opcional.