👋 Seja muito bem-vindo(a) ao Lighthouse do netLex!

Lighthouse é o nosso portal de documentação em que publicamos especificações técnicas sobre nossas integrações e APIs.

Com o Lighthouse, você poderá:

  • Utilizar as especificações técnicas para explorar e usar nossas APIs;

Ainda não conhece o netLex? Então dá só uma espiada no nosso site institucional.

💡 Primeiros passos

Nossa documentação está dividida em autorização e requisições HTTPS.

Autorização

Dividido em:

  • Bearer token: para autenticação nos endpoints é usado Bearer Token.
  • Restrição por IP: é possível, de forma opcional, restringir por IP o acesso aos endpoints.

Requisição HTTPS

Dividido em:

  • Endpoints
    • Document: destinado para manipulação dos documentos do ambiente.
    • DocumentAttachmet: destinado para manipulação dos anexos de documentos.
    • User: destinado para manipulação dos usuários.
    • Contact: destinado para manipulação dos Contatos.
    • Management: destinado para manipulação da gestão dos documentos.

❓ Precisa de suporte?

Caso precise de suporte, entre em contato conosco através da nossa Central de Ajuda.

O Connect é uma API REST que possibilita a execução de scripts configurados na plataforma através de um ID específico. A API recebe dados de entrada (payload)e retorna uma resposta em formato JSON. Em cada script configurado, você pode definir como serão utilizados os métodos das API's privadas da plataforma, que estão disponíveis por meio de classes, usando input como parâmetro. O resultado ou as informações obtidas são então retornadas no output.

Autorização

Bearer Token

É necessário um Bearer Token para autenticar nos endpoints do netLex. O token não possui tempo de expiração. Cada endpoint possui o próprio Bearer Token.

Restrição por IP

É possível também restringir por IP o acesso ao endpoint. É permitido o cadastro de até 100 origens. Essa restrição é opcional.

Requisições HTTPs

Para fazer a requisição de qualquer endpoint do netLex, basta informar a URL composta pelo domínio e o id do endpoint e informar no Header o Bearer token específico. O que vai ser diferente entre as chamadas será o Body REST da requisição e a response, que é definido de acordo com o caso de uso desenvolvido para este endpoint.

Endpoints

Os endpoints do netLex são criados dinamicamente de acordo com a necessidade do caso de uso. Neles será possível configurar um script para realizar ações com as diversas funcionalidades do netLex, como por exemplo criar um documento, atualizar um contato ou retornar informações de workflow, utilizando as funcionalidades presentes nas Classes do Connect.

Classes do Connect

Estão especificadas a seguir as classes possíveis de se manipular dentro dos scripts nos endpoints, considerando os métodos e atributos acessíveis.

  • Document

    Destinado para manipulação dos documentos do ambiente.

    Métodos disponíveis:

    • find: Retorna um documento pelo ID.
    • get: Retorna um iterador com todos ou um conjunto de documentos do ambiente de acordo com os parâmetros informados. A busca é paginada.
    • upload_main_file: Faz upload de um arquivo PDF ou Docx como principal em um documento.
    • save: Registra as alterações. Efetiva a criação.
    • delete: Deleta o documento.
    • to_dict: Retorna um dicionário com os atributos do Documento.

    Atributos disponíveis:

    • id: ID do documento.
    • name: Nome do documento.
    • template_id: ID do template que originou esse documento.
    • metadata: Lista de metadados do documento.
    • folder_id: ID da pasta onde o documento se encontra.
    • type_id: ID do tipo do documento.
    • subtype_id: ID do subtipo do documento.
    • number: Número do documento.
    • is_signed: Documento assinado.
    • answers: Dicionário das respostas do documento.
    • workflow: Workflow do Documento.
    • author: Autor do documento.
    • created_at: Data da criação do documento.
    • updated_at: Data da última atualização do documento.
    • document_file: Arquivo do documento.
    • document_file_pdf: Arquivo do documento em PDF.
    • attachments: Lista de anexos do documento.

    Exemplo de aplicação:

    É possível desenvolver um endpoint onde a finalidade é criar um documento, onde no body da request são informados valores das variáveis que compõem o documento e no body da response é retornado o id do documento dentro da netLex e o base64 dele.

  • DocumentAttachment

    Destinado para manipulação dos anexos de documentos.

    Métodos disponíveis:

    • save: Registra as alterações. Efetiva a criação.
    • to_dict: Retorna um dicionário com os atributos do Anexo.

    Atributos disponíveis:

    • created_at: Data de criação do anexo.
    • description: Descrição do anexo.
    • document_id: ID do documento vinculado ao anexo, usado apenas para criação.
    • extension: Extensão do arquivo do anexo.
    • file: Arquivo do anexo.
    • file_name: Nome do arquivo do anexo.
    • id: Id do anexo.
    • updated_at: Data de atualização do anexo.

    Exemplo de aplicação:

    É possível desenvolver um endpoint onde a finalidade é buscar o base64 de anexo de determinado documento, onde no body da request são informados o id do anexo e o id do documento e no body da response é retornado o nome do anexo e o base64 dele.

  • User

    Destinado para manipulação dos usuários.

    Métodos disponíveis:

    • find: Retorna um usuário pelo ID.
    • find_by_email: Busca o usuário pelo e-mail.
    • get: Retorna um iterador dos usuários de um ambiente.
    • save: Registra as alterações. Efetiva a criação.
    • to_dict: Retorna um dicionário com os atributos do usuário.

    Atributos disponíveis:

    • id: ID do usuário. Tipo: int.
    • name: Nome do usuário. Tipo: str.
    • email: E-mail do usuário. Tipo: str.
    • initials: Iniciais do usuário. Tipo: str.
    • sso: Se o usuário faz login via SSO. Tipo: bool.
    • roles: Lista dos perfis de acessos. Tipo: list.

    Exemplo de aplicação:

    É possível desenvolver um endpoint onde a finalidade é criar um usuário, sendo informado no body da request o nome e e-mail e no body da response é retornado o id do usuário caso criado ou uma mensagem informando que o usuário para aquele e-mail já existe.

  • Contact

    Destinado para manipulação dos Contatos.

    Métodos disponíveis:

    • find: Retorna um contato pelo ID.
    • find_by_document_number: Retorna um contato pelo o número do documento (CPF ou CNPJ).
    • find_by_email: Retorna um contato pelo o email.
    • get: Retorna um iterador dos contatos.
    • save: Registra as alterações. Efetiva a criação.
    • to_dict: Retorna um dicionário com os atributos do Contato.

    Atributos disponíveis:

    • birthdate: Data de nascimento do Contato. Tipo: datetime.
    • cellphone: Número de celular do Contato. Ao criar um contato com essa informação será necessário máscara, "(XX) XXXX-XXXX" ou "(XX) XXXXX-XXXX". Tipo: str.
    • city: Cidade do contato. Tipo: str.
    • contact_type: Tipo do contato. Valor 1 indica Pessoa Jurídica e valor 0 indica Pessoa Física. Tipo: int.
    • country: País do contato. Tipo: str.
    • district: Bairro do endereço do contato. Tipo: str.
    • document_number: CPF ou CNPJ do Contato. Ao criar um contato com essa informação necessário máscara, para CPF "XXX.XXX.XXX-XX" e para CPNJ: "XX.XXX.XXX/XXXX-XX". Tipo: str.
    • email: E-mail do contato. Ao criar um contato com essa informação deverá ser informado um formato válido de e-mail. Tipo: str.
    • father_name: Nome do Pai do contato. Tipo: str.
    • genre: Gênero do contato. Valores predefinidos: "masculino", "feminino". Tipo: str.
    • head_office: Matriz ou Filial. Valor True indica Matriz e valor False indica Filial. Tipo: bool.
    • id: ID do contato. Tipo: int.
    • identity_document: Tipo do documento de identificação do contato. Valores predefinidos: "carteira de identidade", "carteira de identificação funcional", "carteira de trabalho", "carteira nacional de habilitação", "carteira profissional", "cédula de identidade militar", "identidade de estrangeiro (RNE)", "passaporte". Tipo: str.
    • identity_issuer: Orgão emissor do documento de identificação do contato. Tipo: str.
    • identity_number: Número do documento de identificação do contato. Tipo: str.
    • job_title: Profissão do contato. Tipo: str.
    • marital_status: Estado civil do contato. Valores predefidos: "casado", "divorciado", "separado", "solteiro", "viúvo", "casada", "divorciada", "separada", "solteira", "viúva", "união estável". Tipo: str.
    • mother_name: Nome da mãe do contato. Tipo: str.
    • municipal_registration: Registro Municipal do contato. Tipo: str.
    • name: Nome do contato. Tipo: str.
    • nationality: Nacionalidade do contato. Valores predefinidos: Lista muito extensa, quando necessário, favor soliciar ao netLex. Tipo: str.
    • nickname: Apelido ou Nome Fantasia do contato. Tipo: str.
    • nire: Número do NIRE do contato. Tipo: str.
    • phone: Telefone do contato. Ao criar um contato com essa informação necessário máscara, "(XX) XXXX-XXXX". Tipo: str.
    • professional_identity: Identificação Profissional do contato. Tipo: str.
    • professional_identity_issuer: Orgão emissor da Identificação Profissional do contato. Tipo: str.
    • state: Estado do contato. Ao criar um contato com essa informação necessário informar a sigla do estado em maiúsculo. Tipo: str.
    • state_registration: Inscrição estadual do contato. Tipo: str.
    • street: Rua do endereço do contato. Tipo: str.
    • street_complement: Completemento do endereço do contato. Tipo: str.
    • street_number: Número do endereço do contato. Tipo: str.
    • type: Tipo societário do contato. Valores predefinidos: Lista muito extensa, quando necessário, favor soliciar ao netLex. Tipo: str.
    • voter_document: Título de eleitor do contato. Tipo: str.
    • website: Site do contato. Tipo: str.
    • work_document: Informações da carteira de trabalho do contato. Tipo: str.
    • zip_code: CEP do contato. Ao criar um contato com essa informação necessário máscara, "XX.XXX-XX". Tipo: str.

    Exemplo de aplicação:

    É possível desenvolver um endpoint onde a finalidade é criar um contato, sendo informado no body da request vários atributos e no body da response é retornado o id do contato caso criado ou uma mensagem informando que já existe um contato com o mesmo cpf/cnpj ou e-mail.

  • Management

    Conjunto de classes que permitem a manipulação da gestão dos documentos. Sendo possível manipular Abas, Tabelas, Colunas, Linhas e Células.

    Exemplo de aplicação:

    É possível desenvolver um endpoint onde a finalidade seja alterar valores em uma tabela inserida na gestão do documento. Supondo que um documento tem uma tabela que conterá os registros dos boletins de medição, conforme imagem a seguir:

    Com isso, é possível informar na requisição qual o documento, produto e quantidade a qual serão feitas as alterações, como demonstrado a seguir:

    O endpoint receberá os valores e fará a alteração na gestão seguindo as diretrizes do caso de uso, sendo possível manter as informações atualizadas de acordo com outros sistemas.