👋 ¡Le damos la bienvenida al Lighthouse de netLex!

Lighthouse es nuestro portal de documentación, en el que publicamos especificaciones técnicas sobre nuestras integraciones y API.

Con Lighthouse, usted podrá:

  • Utilizar las especificaciones técnicas para explorar y usar nuestras API;

¿Aún no conoce netLex? Entonces eche un vistazo a nuestro sitio web institucional.

💡 Primeros pasos

Nuestra documentación está dividida en autorización y solicitudes HTTPS.

Autorización

Dividido en:

  • Bearer token: para la autenticación en los endpoints se utiliza Bearer Token.
  • Restricción por IP: es posible, de forma opcional, restringir por IP el acceso a los endpoints.

Solicitud HTTPS

Dividido en:

  • Endpoints
    • Document: destinado a la manipulación de los documentos del entorno.
    • DocumentAttachmet: destinado a la manipulación de los anexos de documentos.
    • User: destinado a la manipulación de los usuarios.
    • Contact: destinado a la manipulación de los Contactos.
    • Management: destinado a la manipulación de la gestión de los documentos.

❓ ¿Necesita soporte?

Si necesita soporte, contáctenos a través de nuestro Centro de Ayuda.

Connect es una API REST que permite la ejecución de scripts configurados en la plataforma a través de un ID específico. La API recibe datos de entrada (payload) y devuelve una respuesta en formato JSON. En cada script configurado, usted puede definir cómo se utilizarán los métodos de las API privadas de la plataforma, que están disponibles por medio de clases, usando input como parámetro. El resultado o la información obtenida se devuelve luego en el output.

Autorización

Bearer Token

Se requiere un Bearer Token para autenticarse en los endpoints de netLex. El token no tiene tiempo de expiración. Cada endpoint tiene su propio Bearer Token.

Restricción por IP

También es posible restringir por IP el acceso al endpoint. Se permite el registro de hasta 100 orígenes. Esta restricción es opcional.

Solicitudes HTTPS

Para realizar la solicitud a cualquier endpoint de netLex, basta con informar la URL compuesta por el dominio y el ID del endpoint, e informar en el Header el Bearer token específico. Lo que variará entre las llamadas será el Body REST de la solicitud y la response, que se define de acuerdo con el caso de uso desarrollado para este endpoint.

Endpoints

Los endpoints de netLex se crean dinámicamente de acuerdo con la necesidad del caso de uso. En ellos será posible configurar un script para realizar acciones con las diversas funcionalidades de netLex, como por ejemplo crear un documento, actualizar un contacto o devolver información de workflow, utilizando las funcionalidades presentes en las Clases de Connect.

Clases de Connect

A continuación se especifican las clases que es posible manipular dentro de los scripts en los endpoints, considerando los métodos y atributos accesibles.

  • Document

    Destinado a la manipulación de los documentos del entorno.

    Métodos disponibles:

    • find: Devuelve un documento por su ID.
    • get: Devuelve un iterador con todos o un conjunto de documentos del entorno de acuerdo con los parámetros informados. La búsqueda es paginada.
    • upload_main_file: Carga un archivo PDF o Docx como archivo principal en un documento.
    • save: Registra los cambios. Hace efectiva la creación.
    • delete: Elimina el documento.
    • to_dict: Devuelve un diccionario con los atributos del Documento.

    Atributos disponibles:

    • id: ID del documento.
    • name: Nombre del documento.
    • template_id: ID de la plantilla que originó este documento.
    • metadata: Lista de metadatos del documento.
    • folder_id: ID de la carpeta donde se encuentra el documento.
    • type_id: ID del tipo de documento.
    • subtype_id: ID del subtipo de documento.
    • number: Número del documento.
    • is_signed: Documento firmado.
    • answers: Diccionario de las respuestas del documento.
    • workflow: Workflow del documento.
    • author: Autor del documento.
    • created_at: Fecha de creación del documento.
    • updated_at: Fecha de la última actualización del documento.
    • document_file: Archivo del documento.
    • document_file_pdf: Archivo del documento en PDF.
    • attachments: Lista de anexos del documento.

    Ejemplo de aplicación:

    Es posible desarrollar un endpoint cuya finalidad sea crear un documento, en el que en el body de la request se informan los valores de las variables que componen el documento y en el body de la response se devuelve el ID del documento dentro de netLex y su base64.

  • DocumentAttachment

    Destinado a la manipulación de los anexos de documentos.

    Métodos disponibles:

    • save: Registra los cambios. Hace efectiva la creación.
    • to_dict: Devuelve un diccionario con los atributos del Anexo.

    Atributos disponibles:

    • created_at: Fecha de creación del anexo.
    • description: Descripción del anexo.
    • document_id: ID del documento vinculado al anexo, utilizado solo para la creación.
    • extension: Extensión del archivo del anexo.
    • file: Archivo del anexo.
    • file_name: Nombre del archivo del anexo.
    • id: ID del anexo.
    • updated_at: Fecha de actualización del anexo.

    Ejemplo de aplicación:

    Es posible desarrollar un endpoint cuya finalidad sea obtener el base64 del anexo de un documento determinado, en el que en el body de la request se informan el ID del anexo y el ID del documento, y en el body de la response se devuelve el nombre del anexo y su base64.

  • User

    Destinado a la manipulación de los usuarios.

    Métodos disponibles:

    • find: Devuelve un usuario por su ID.
    • find_by_email: Busca al usuario por su e-mail.
    • get: Devuelve un iterador de los usuarios de un entorno.
    • save: Registra los cambios. Hace efectiva la creación.
    • to_dict: Devuelve un diccionario con los atributos del usuario.

    Atributos disponibles:

    • id: ID del usuario. Tipo: int.
    • name: Nombre del usuario. Tipo: str.
    • email: E-mail del usuario. Tipo: str.
    • initials: Iniciales del usuario. Tipo: str.
    • sso: Indica si el usuario inicia sesión mediante SSO. Tipo: bool.
    • roles: Lista de los perfiles de acceso. Tipo: list.

    Ejemplo de aplicación:

    Es posible desarrollar un endpoint cuya finalidad sea crear un usuario, en el que en el body de la request se informan el nombre y el e-mail, y en el body de la response se devuelve el ID del usuario en caso de que haya sido creado o un mensaje que informa que ya existe un usuario para ese e-mail.

  • Contact

    Destinado a la manipulación de los Contactos.

    Métodos disponibles:

    • find: Devuelve un contacto por su ID.
    • find_by_document_number: Devuelve un contacto por el número de documento (CPF o CNPJ).
    • find_by_email: Devuelve un contacto por el e-mail.
    • get: Devuelve un iterador de los contactos.
    • save: Registra los cambios. Hace efectiva la creación.
    • to_dict: Devuelve un diccionario con los atributos del Contacto.

    Atributos disponibles:

    • birthdate: Fecha de nacimiento del Contacto. Tipo: datetime.
    • cellphone: Número de celular del Contacto. Al crear un contacto con esta información será necesaria la máscara "(XX) XXXX-XXXX" o "(XX) XXXXX-XXXX". Tipo: str.
    • city: Ciudad del contacto. Tipo: str.
    • contact_type: Tipo de contacto. El valor 1 indica Persona Jurídica y el valor 0 indica Persona Física. Tipo: int.
    • country: País del contacto. Tipo: str.
    • district: Barrio de la dirección del contacto. Tipo: str.
    • document_number: CPF o CNPJ del Contacto. Al crear un contacto con esta información es necesaria la máscara: para CPF "XXX.XXX.XXX-XX" y para CNPJ "XX.XXX.XXX/XXXX-XX". Tipo: str.
    • email: E-mail del contacto. Al crear un contacto con esta información se deberá informar un formato de e-mail válido. Tipo: str.
    • father_name: Nombre del padre del contacto. Tipo: str.
    • genre: Género del contacto. Valores predefinidos: "masculino", "feminino". Tipo: str.
    • head_office: Matriz o Sucursal. El valor True indica Matriz y el valor False indica Sucursal. Tipo: bool.
    • id: ID del contacto. Tipo: int.
    • identity_document: Tipo de documento de identificación del contacto. 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: Órgano emisor del documento de identificación del contacto. Tipo: str.
    • identity_number: Número del documento de identificación del contacto. Tipo: str.
    • job_title: Profesión del contacto. Tipo: str.
    • marital_status: Estado civil del contacto. Valores predefinidos: "casado", "divorciado", "separado", "solteiro", "viúvo", "casada", "divorciada", "separada", "solteira", "viúva", "união estável". Tipo: str.
    • mother_name: Nombre de la madre del contacto. Tipo: str.
    • municipal_registration: Registro Municipal del contacto. Tipo: str.
    • name: Nombre del contacto. Tipo: str.
    • nationality: Nacionalidad del contacto. Valores predefinidos: lista muy extensa; cuando sea necesario, favor de solicitarla a netLex. Tipo: str.
    • nickname: Apodo o Nombre Comercial del contacto. Tipo: str.
    • nire: Número de NIRE del contacto. Tipo: str.
    • phone: Teléfono del contacto. Al crear un contacto con esta información es necesaria la máscara "(XX) XXXX-XXXX". Tipo: str.
    • professional_identity: Identificación Profesional del contacto. Tipo: str.
    • professional_identity_issuer: Órgano emisor de la Identificación Profesional del contacto. Tipo: str.
    • state: Estado del contacto. Al crear un contacto con esta información es necesario informar la sigla del estado en mayúsculas. Tipo: str.
    • state_registration: Inscripción estatal del contacto. Tipo: str.
    • street: Calle de la dirección del contacto. Tipo: str.
    • street_complement: Complemento de la dirección del contacto. Tipo: str.
    • street_number: Número de la dirección del contacto. Tipo: str.
    • type: Tipo societario del contacto. Valores predefinidos: lista muy extensa; cuando sea necesario, favor de solicitarla a netLex. Tipo: str.
    • voter_document: Título de elector (título de eleitor) del contacto. Tipo: str.
    • website: Sitio web del contacto. Tipo: str.
    • work_document: Información de la cartera de trabajo (carteira de trabalho) del contacto. Tipo: str.
    • zip_code: CEP (código postal) del contacto. Al crear un contacto con esta información es necesaria la máscara "XX.XXX-XX". Tipo: str.

    Ejemplo de aplicación:

    Es posible desarrollar un endpoint cuya finalidad sea crear un contacto, en el que en el body de la request se informan varios atributos y en el body de la response se devuelve el ID del contacto en caso de que haya sido creado o un mensaje que informa que ya existe un contacto con el mismo CPF/CNPJ o e-mail.

  • Management

    Conjunto de clases que permiten la manipulación de la gestión de los documentos. Es posible manipular Pestañas, Tablas, Columnas, Filas y Celdas.

    Ejemplo de aplicación:

    Es posible desarrollar un endpoint cuya finalidad sea modificar valores en una tabla insertada en la gestión del documento. Suponiendo que un documento tiene una tabla que contendrá los registros de los productos, como se muestra en la siguiente imagen:

    Con esto, es posible informar en la solicitud cuál es el documento, el producto y la cantidad sobre los que se realizarán las modificaciones, como se demuestra a continuación:

    El endpoint recibirá los valores y realizará la modificación en la gestión siguiendo las directrices del caso de uso, lo que permite mantener la información actualizada de acuerdo con otros sistemas.