API Zen 2 - V2
  1. Arquivos
API Zen 2 - V2
  • API Zen 2 - V2
    • Raiz
      • Arquivos
        • Insere um anexo de documento no storage.
          POST
      • Autenticação
        • Realiza o login de um usuário na API utilizando e-mail e senha.
      • E-Doc
        • Consultar Pastas.
        • Cadastro de Documento.
        • Cancelar Documento.
      • Gerenciador de Empresas
        • Consulta informações sobre as empresas com base nos filtros fornecidos.
        • Cadastro de uma nova empresa no sistema.
        • Consulta informações sobre os departamentos com base nos filtros fornecidos.
        • Edição de uma empresa existente no sistema.
        • Consulta os grupos de empresas existentes no sistema, com base nos filtros fornecidos.
        • Consulta os perfis de acesso com base nos filtros fornecidos.
      • Gerenciador de Usuários
        • Criação de Usuário Empresa.
        • Consulta de Usuário(s) Empresa.
        • Vincular Usuário a Empresa(s).
        • Criação de Usuário Escritório.
        • Consulta de Usuário(s) Escritório.
      • Q-Colabore
        • Consultar Pastas.
        • Cancelar Documento.
        • Cadastro de Documento.
      • Q-Drive Documentos Fiscais
        • Realiza a importação de documentos fiscais, incluindo NF-e, CT-e, CT-e OS, NFC-e, CF-e e seus respectivos eventos.
      • Q-Drive NFS-e
        • Realiza a importação de Notas Fiscais de Serviço Eletrônica (NFS-e).
    • Esquemas
      • Schemas
        • AtivoInativoEnum
        • CadastroDocumentoEdocApiModel
        • CadastroDocumentoQcolaboreApiModel
        • ConsultaEmpresaModel
        • ConsultaUsuarioEmpresaModel
        • ConsultaUsuarioEscritorioModel
        • ConsultarPastasApiModel_EdocSubpastaApiModel
        • ConsultarPastasApiModel_QColaboreSubpastaApiModel
        • DFe_Classes_Flags_TipoAmbiente
        • DepartamentoRetornoApiModel
        • DownloadArquivoRetornoApiModel
        • EditarEmpresaApiModel
        • EdocSubpastaApiModel
        • EmpresaCadastroDocumentoApi
        • EmpresaRetornoApiModel
        • EnderecoApiModel
        • EnderecoEmpresa
        • GrupoEmpresaRetornoApiModel
        • InformacoesAdicionaisApiModel
        • InformacoesAdicionaisEmpresa
        • InserirEmpresaApiModel
        • InserirUsuarioEscritorioApiModel
        • LoginRetornoApi
        • LoginUsuarioApiV2Model
        • PerfilAcessoRetornoApiModel
        • PerfilTareffaApi
        • QColaboreSubpastaApiModel
        • QuestorZen_Application_Edoc_Models_CadastroDocumentoQcolaboreApiModel_EmpresaCadastroDocumentoApi
        • RegimeTributarioEnum
        • ResultadoImportacao
        • ResumoArquivoImportacao
        • RetornoApi
        • RetornoApi_ConsultaUsuarioEmpresaModel
        • RetornoApi_DepartamentoRetornoApiModel
        • RetornoApi_EmpresaRetornoApiModel
        • RetornoApi_GrupoEmpresaRetornoApiModel
        • RetornoApi_IEnumerable_ConsultaUsuarioEscritorioModel
        • RetornoApi_IEnumerable_ConsultarPastasApiModel_EdocSubpastaApiModel
        • RetornoApi_IEnumerable_ConsultarPastasApiModel_QColaboreSubpastaApiModel
        • RetornoApi_IEnumerable_DownloadArquivoRetornoApiModel
        • RetornoApi_Int64
        • RetornoApi_LoginRetornoApi
        • RetornoApi_Object
        • RetornoApi_PerfilAcessoRetornoApiModel
        • RetornoApi_ResultadoImportacao
        • RetornoApi_String
        • TipoAmbiente
        • TipoDepartamento
        • TipoDocumentoFiscal
        • TipoFone
        • TipoInscricao
        • UsuarioDestino
        • UsuarioDestinoEdoc
        • UsuarioEmpresaApiModel
        • VinculoEmpresaUsuarioApiV2Model
  1. Arquivos

Insere um anexo de documento no storage.

POST
/v2/Arquivos
Este endpoint permite a inserção de arquivos. Os arquivos serão compactados em ZIP e armazenados.
Os arquivos são recebidos em formato multipart e compactados para armazenar no serviço de armazenamento.
Exemplo de Requisição (FormData):
{
    "Arquivos": [
        {
            "ContentType": "application/zip",
            "FileName": "documento1.zip",
            "Length": 1024
        }
    ]
}
Exemplo de Resposta de Sucesso (200 - OK):
 {
   "dados": {
    "id": "67ab522b78207849e4be5dfd"
    },
    "sucesso": true,
    "mensagens": "Anexo inserido com sucesso"
 }
Respostas:
200 OK: Retorna o ID do anexo inserido com sucesso.
400 Bad Request: Se não houver arquivos para processar ou se os arquivos estiverem malformados.
500 Internal Server Error: Erro interno durante o processo de inserção do anexo.

Requisição

Authorization
API Key
Adicionar parâmetro em header
Authorization
Exemplo:
Authorization: ********************
or
Parâmetros Bodymultipart/form-data

Respostas

🟢200OK
application/json
Retorna o ID do anexo inserido com sucesso.
Body

🟠400Solicitação incorreta
🔴500Erro interno do servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/Arquivos' \
--header 'Authorization: <api-key>' \
--form 'Arquivos=""'
Response Response Example
200 - Exemplo 1
{
    "sucesso": true,
    "mensagens": "string",
    "dados": [
        {
            "idArquivo": 0,
            "nomeArquivo": "string",
            "arquivoBase64": "string",
            "mensagemErro": "string"
        }
    ]
}
Modificado em 2025-09-24 14:39:45
Próxima página
Realiza o login de um usuário na API utilizando e-mail e senha.
Built with