🟩 Métodos disponíveis na API
| Nº | TAG | Método | Descrição | Status |
|---|---|---|---|---|
| 1.1 | Autenticacao | POST /api/Autenticacao/Login | Gerar token de autenticação V1 | Disponível |
| 1.2 | Autenticacao | POST /api/Autenticacao/RefreshToken | Atualizar token de autenticação V1 | Disponível |
| 2.1 | Arquivo | GET /api/Arquivo/Get | Buscar arquivos de um documento V1 | Disponível |
| 2.2 | Arquivo | POST /api/Arquivo/Post | Cadastrar arquivos em um documento V1 | Disponível |
| 2.3 | Arquivo | POST /api/Arquivo/Upload | Cadastrar arquivos em um documento, retornando os id’s das imagens V1 | Disponível |
| 2.4 | Arquivo | DEL /api/Arquivo/Delete | Deletar um arquivo de um documento V1 | Disponível |
| 2.5 | Arquivo | GET /api/Arquivo/{idImagem}/Cliente/{idCliente} | Buscar arquivo de um cliente V1 | Disponível |
| 2.6 | Arquivo | POST /api/Arquivo/assinar-arquivos | Assinar eletronicamente arquivos de um Cliente V1 | Disponível |
| 3.1 | Billing | GET /api/Billing/Get | Buscar as faturas de uma unidade V1 | Disponível |
| 3.2 | Billing | GET /api/Billing/Get/Conta | Buscar os dados de uma fatura da unidade V1 | Disponível |
| 4.1 | Documento | PUT /api/Documento/Put | Alterar um documento de um Cliente V1 | Disponível |
| 4.2 | Documento | POST /api/Documento/Post | Cadastrar um documento de um Cliente V1 | Disponível |
| 4.3 | Documento | POST /api/v2/Documento | Cadastrar um documento de um Cliente: com compartilhamento V2 | Disponível |
| 4.4 | Documento | GET /api/Documento/Get | Buscar documentos de um Cliente V1 | Disponível |
| 4.5 | Documento | GET
/api/Documento/{idDocumento}/cliente/{idCliente}/compartilhar-arquivos |
Consultar link de compartilhamento dos arquivos de um documento V2 | Disponível |
| 4.6 | Documento | PATCH
/api/documento/{idDocumento}/cliente/{idCliente}/removercompartilhamento-arquivos |
Deletar link de copartilhamento dos arquivos de um documento V2 | Disponível |
| 4.7 | Documento | DEL /api/Documento/Delete | Deletar um documento de um Cliente V1 | Disponível |
| 4.8 | Documento | POST
/api/documento/{idDocumento}/cliente/{idCliente}/compartilhar-arquivos |
Gerar link de compartilhamento dos arquivos de um documento V2 | Disponível |
| 5.1 | Lista | GET /api/Lista/GetListas | Buscar as listas do Cliente V1 | Disponível |
| 5.2 | Lista | GET /api/Lista/GetCamposDaLista | Buscar os campos de uma Lista V1 | Disponível |
| 5.3 | Lista | GET /api/Lista/GetLinhaLista | Buscar os dados de uma Lista V1 | Disponível |
| 5.4 | Lista | PUT /api/Lista/{idLista}/Cliente/{idCliente}/LinhaLista/{idLinhaLista} | Alterar dados de um item de lista V1 | Disponível |
| 5.5 | Lista | POST /api/AdicionarItemLista/Post | Cadastrar um item de lista V1 | Disponível |
| 5.6 | Lista | POST /api/Lista/RetornaLinhaListasPorCampoValor/{idLista}/{idUnidade}/{idCliente} | Buscar itens de lista V1 | Disponível |
| 6.1 | Workflow | GET /api/ConfWorkflow/{idCliente} | Buscar configurações de fluxos V1 | Disponível |
| 6.2 | Workflow | POST /api/Workflow/Ativar | Ativar um fluxo V1 | Disponível |
| 6.3 | Workflow | PATCH /api/Workflow/Cliente/{idCliente}/associar-documentos | Associar documentos a um fluxo V1 | Disponível |
| 6.4 | Workflow | GET /api/ConfWorkflow/{idConfWorkflow}/Cliente/{idCliente}/fluxos-ativados | Buscar fluxos ativados de uma configuração V1 | Disponível |
| 6.5 | Workflow | GET /api/Workflow/Cliente/{idCliente}/dados-fluxo | Buscar dados de um fluxo V1 | Disponível |
| 6.6 | Workflow | GET /api/Workflow/Cliente/{idCliente}/modelo-fluxo | Buscar modelo de um fluxo V1 | Disponível |
| 6.7 | Workflow | PATCH /api/Workflow/EtapaExecucao/{idWorkflowEtapaExecucao}/Cliente/{idCliente}/atualizar-dados-formulario | Atualizar formulário de um fluxo V1 | Disponível |
| 7.1 | Nota Fiscal | POST /api/NotaFiscal/ImportaNotaFiscal | Cadastrar nota fiscal como documento: não usar este método. Usar o método POST Documento | Disponível |
| 8.1 | Relatórios | GET /api/Relatorios/GetRelatorios | Buscar relatórios V1 | Disponível |
| 8.2 | Relatórios | GET /api/Relatorios/GetDadosRelatorios | Buscar dados de um relatório V1 | Disponível |
| 9.1 | Usuário | POST /api/Usuario/AdicionarUsuario | Cadastrar um usuário V1 | Disponível |
| 9.2 | Usuário | PATCH /api/Usuario/{IdUsuario}/AlterarSenhaUsuario | Alterar senha de um usuário V1 | Disponível |
| 9.3 | Usuário | PATCH /api/Usuario/{IdUsuario}/AlterarStatusUsuario | Alterar status de um usuário V1 | Disponível |
Códigos Retorno de Validações
Code: 200 – OK
Este código é a resposta de status de sucesso que indica que a requisição foi bem-sucedida.
Code: 201 – Created
Este código é retornado quando a requisição foi bem-sucedida e um registro é criado com sucesso.
Code: 400 – Bad Request
Este erro é retornado quando não for possível interpretar a requisição e/ou o servidor tenta processar a solicitação, mas algum parâmetro da solicitação não é válido, por exemplo, um recurso formatado incorretamente ou uma tentativa de requisição com dados faltantes. As informações sobre a solicitação são fornecidas no corpo da resposta e incluem um código de erro e uma mensagem de erro.
a- Item obrigatório
b- Formato incorreto
c- Ids inexistente.
d- Algum parâmetro está incorreto ou é inexistente
Code: 401 – Unauthorized
Este erro é retornado quando ocorre alguma falha na autorização e/ou os parâmetros de autenticação estão incorretos.
Code: 404 Not Found
Este erro é retornado quando o recurso solicitado ou o endpoint não foi localizado.
Code: 422 – Unprocessable
Este erro é retornado quando a requisição foi recebida com sucesso, porém contém parâmetros inválidos.
Code: 500 – Server Error
Este erro é retornado quando:
- Ocorre um erro interno no servidor.
- Ocorre uma falha na plataforma ArqGed.
- Formato do parâmetro incorreto.
- Formato do JSON incorreto.
Atualizado há 5 dias