API Zen 2 - V2
  1. Autenticação
API Zen 2 - V2
  • Raiz
    • Autenticação
      • Realiza o login de um usuário na API utilizando e-mail e senha.
        POST
    • E-Doc
      • Consultar Pastas.
      • Insere um anexo de documento no storage.
      • 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.
      • Edição de uma empresa existente no sistema.
      • Consulta os grupos de empresas existentes no sistema, com base nos filtros fornecidos.
    • 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.
      • Realiza a importação de Notas Fiscais de Serviço Eletrônica (NFS-e).
  • Esquemas
    • Schemas
      • AtivoInativoEnum
      • CadastroDocumentoEdocApiModel
      • CadastroDocumentoQcolaboreApiModel
      • EditarEmpresaApiModel
      • InserirEmpresaApiModel
      • InserirUsuarioEscritorioApiModel
      • InserirUsuarioEscritorioComSenhaApiModel
      • LoginUsuarioApiV2Model
      • 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
      • UsuarioEmpresaApiModel
      • VinculoEmpresaUsuarioApiV2Model
  1. Autenticação

Realiza o login de um usuário na API utilizando e-mail e senha.

POST
/v2/Autenticacao/loginUsuario
Este endpoint permite que um usuário autenticado com permissões, utilizando suas credenciais (e-mail e senha).
Validações:
O modelo de dados deve estar corretamente preenchido (e-mail, senha e QuestorId).
A autenticação nao permitida para usuarios com autenticação em dois fatores habilitada.
Apenas usuários com perfil administrador e com a permissão PermitirAcessoAPI ativada poderão autenticar.
Respostas:
200 OK: Login efetuado com sucesso. Retorna o token de autenticação e dados do usuário.
400 Bad Request: Dados inválidos ou QuestorId inconsistente com o escritório.
401 Unauthorized: Credenciais inválidas, autenticação em dois fatores ativada ou usuário sem permissão para acessar a API.
500 Internal Server Error: Erro interno ao processar a solicitação.
Exemplo de Requisição:
{
    "email": "usuario@empresa.com",
    "senha": "SenhaSegura123"
}
Exemplo de Resposta de Sucesso (200):
{
    "sucesso": true,
    "mensagens": "Autenticação concluída com sucesso.",
    "dados": {
        "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
        "expiresIn": "2025-08-07T12:00:00Z"
    }
}
Exemplo de Resposta de Erro (400 - Bad Request):
{
    "sucesso": false,
    "mensagens": "E-mail ou senha inválidos, ou o QuestorId não corresponde ao escritório atual.",
    "dados": null
}
Exemplo de Resposta de Erro (401 - Unauthorized):
{
    "sucesso": false,
    "mensagens": "Usuário sem permissão para acessar a API ou com autenticação em dois fatores habilitada.",
    "dados": null
}
Exemplo de Resposta de Erro (500 - Internal Server Error):
{
    "sucesso": false,
    "mensagens": "Erro interno ao processar a solicitação.",
    "dados": null
}

Requisição

Authorization
API Key
Adicionar parâmetro em header
Authorization
Exemplo:
Authorization: ********************
or
Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK
application/json
Login efetuado com sucesso.
Body

🟠400Solicitação Incorreta
🟠401Não Autorizado
🔴500Erro do Servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/Autenticacao/loginUsuario' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "string",
    "senha": "string"
}'
Response Response Example
200 - Exemplo 1
{
    "sucesso": true,
    "mensagens": "string",
    "dados": {}
}
Modificado em 2025-08-27 13:38:15
Próxima página
Consultar Pastas.
Built with