API Zen 2 - V2
  1. Gerenciador de Usuários
API Zen 2 - V2
  • API Zen 2 - V2
    • Raiz
      • Arquivos
        • Insere um anexo de documento no storage.
      • 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.
          POST
        • Consulta de Usuário(s) Empresa.
          GET
        • Vincular Usuário a Empresa(s).
          POST
        • Criação de Usuário Escritório.
          POST
        • Consulta de Usuário(s) Escritório.
          GET
      • 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. Gerenciador de Usuários

Vincular Usuário a Empresa(s).

POST
/v2/Usuarios/{usuarioId}/Empresas/Vincular
Este endpoint permite criar vínculos entre um usuário específico e uma ou mais empresas.
O vínculo é criado a partir do Id do usuário e uma lista de IDs de empresas.
Validações:
O Id do usuário deve ser válido e existir no sistema.
A lista de empresas não pode estar vazia.
Caso a validação falhe, a operação será abortada e um erro de validação será retornado.
Respostas:
Sucesso: Retorna uma confirmação do vínculo realizado com sucesso.
Falha: Detalha erros, como parâmetros inválidos ou não encontrados.
Exemplo de Requisição (Rota):
POST /api/v2/Usuarios/488/Empresas/Vincular
Onde 488 é o UsuarioId que será vinculado às empresas.
Exemplo de Requisição (Body JSON):
{
  "EmpresasId": [1, 2, 3]
}
Validações Executadas:
O campo UsuarioId é obrigatório e deve ser um número válido.
O campo EmpresasId é obrigatório e deve conter ao menos um ID de empresa válido.
Exemplo de Resposta de Sucesso:
{
 "sucesso": true,
  "mensagem": "As empresas foram associadas ao usuário com sucesso.",
  "dados": null
}
Exemplo de Resposta de Erro:
{
 "sucesso": false,
  "mensagem": "Parâmetros inválidos fornecidos, como falta de Id de usuário ou lista de empresas vazia.",
  "dados": null
}

Requisição

Authorization
API Key
Adicionar parâmetro em header
Authorization
Exemplo:
Authorization: ********************
or
Parâmetros de Caminho

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK
application/json
Vínculos realizados com sucesso.
Body

🟠400Solicitação incorreta
🟠404Não encontrado
🔴500Erro interno do servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/Usuarios//Empresas/Vincular' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "empresasId": [
        1,
        2,
        3
    ]
}'
Response Response Example
200 - Exemplo 1
{
    "sucesso": true,
    "mensagens": "string",
    "dados": null
}
Modificado em 2025-09-24 14:39:45
Página anterior
Consulta de Usuário(s) Empresa.
Próxima página
Criação de Usuário Escritório.
Built with