APIs
      Volver al inicio
      1. Documentación
      2. Documentacion Tecnica
      3. APIs

      API Servicios

      En esta sección se definirán los entornos disponibles de consumo mediante uso de la aplicación.

      Es importante tener en cuenta que para poder acceder a esta información, es necesario contar con los permisos correspondientes y tener una aplicación activa.

      Todos los endpoints precisan autenticación. Caso contrario se respondera con el estado HTTP 403 (forbidden) o se aclarará en el método.

      1- LEGAJOS (expedientes digitales)

       Se define como legajo a la entidad que encapsula toda la información definida y almacenada por el solicitante en el uso del flujo a través de las pantallas.

      Recuerda que las propiedades que componen imágenes proveerán la URL a la cual deberá consumir el archivo en base64.

      Tabla con propiedades (base) de un legajo y tipo de dato: https://docs.google.com/spreadsheets/d/1EEh6EpP2bjAZMV5w3jA2yv8lOm0HT4f3EKBYJfnRi18/edit?usp=sharing

       

      La API de Legajos se utiliza para crear, editar o leer un legajo.

      Crear: Inserta un legajo en el backoffice

      Editar: Edita propiedades de un legajo del backoffice

      Leer: Permite obtener la información de un legajo en el backoffice. Esta acción se suele combinar con webhooks. Es decir, el cliente cuando recibe un webhook informándole que un legajo llegó al 100% de completitud, ejecuta la API de lectura y le permite migrar la data a su sistema.

       

      Lectura

      Método: GET

      Endpoint: https://api..digiventures.la/:applicationVersion/legajo/:legajoId

      Autenticación: sí

      Respuesta: Todas las propiedades del legajo exceptuando las ocultas o propiedades modificadas por la aplicación por la cual se consultó.

       Escritura

      Método: POST

      Endpoint: https://api..digiventures.la/:applicationVersion/legajo

      Autenticación: sí

      Parámetros (envíados en el body de la request):

        • Nombre/Apellido: String. Puede enviarse de 2 maneras:

          • firstname / lastname: String - nombre y apellido por separado, el endpoint los combina y genera automáticamente el campo name

          • name: String - Contiene ambos valores correspondientes a firstname + lastname

        • email: String

        • idNumber: Number - Número de identificación del usuario

        • outputUrls: Objeto - (opcional) Objeto con URLs para redirigir al usuario según los distintos finales del flujo. Deben ser URLs completas con prefijo HTTP o HTTPS

          • congrats: String (opcional)

          • congratsPrevious: String (opcional)

          • pending: String (opcional)

          • denied: String (opcional)

          • error: String (opcional)

        • Todas las propiedades del legajo que se quieran pre-completar al momento de la creación del mismo

      Respuesta:

        • Todas las propiedades del legajo exceptuando las ocultas o propiedades modificadas por la aplicación por la cual se consultó.

      Ejemplo de Request:

      {

      "firstname": "Juan",

      "lastname": "Perez",

      "gender": "Masculino",

      "email": "juan.pe@gmail.com",

      "typeScoring": "Directo",

      "idNumber": 12345678,

      "activity": false,

      "mobilePhone": "+541155559999",

      "monthlyIncome": 50000,

      "contract": {

      "text": "Demo Contract"

      },

      "outputUrls": {

      "congrats": "https://www.google.com",

      "congratsPrevious": "https://www.google.com",

      "pending": "https://www.google.com",

      "denied": "https://www.google.com",

      "error": "https://www.google.com",

      }

      }

      Ejemplo de Response:

      • Response: Status code: 200

      • Response Body:

      {

      "contract": {

      "text": "Demo Contract"

      },

      "outputUrls": {

      "congrats": "https://www.google.com",

      "congratsPrevious": "https://www.google.com",

      "pending": "https://www.google.com",

      "denied": "https://www.google.com",

      "error": "https://www.google.com",

      },

      "authentication": {

      "email": {

      "validated": false

      }

      },

      "notifications": {

      "history": []

      },

      "external": {

      "pipedrive": {

      "files": []

      }

      },

      "scoring": {

      "history": [],

      "updatedAt": []

      },

      "managment": {

      "participants": []

      },

      "activity": true,

      "_id": "6f920a0765ceb9876fa820d",

      "firstname": "Juan",

      "lastname": "Perez",

      "gender": "Masculino",

      "email": "juan.pe@gmail.com",

      "typeScoring": "Directo",

      "idNumber": 12345678,

      "mobilePhone": "+541155559999",

      "monthlyIncome": 50000,

      "tenantId": "5f9497b235c50e001069b7e9",

      "dev": false,

      "name": "Juan Perez",

      "userId": "5f189a0516312a0fad5c3les",

      "totalComplete": 30,

      "notes": [],

      "createdAt": "2020-10-22T13:32:55.518Z",

      "updatedAt": "2020-10-22T13:32:55.577Z",

      "__v": 0,

      "linkLandingNext": "https://tenant.url.com.ar/landing_next?tokenLegajo=6f920a0765ceb9876fa820d",

      "linkRecover": "https://tenant.urlcom.ar/?mail=juan.pe%40gmail.com&recover=6f920a0765ceb9876fa820d&utm_recovery=true"

      }

      nota: Para iniciar un circuito se debe invocar el valor del atributo linkRecover.

       

      Endpoint: https://api..digiventures.la/:applicationVersion/legajo/:legajoId

      Autenticación: Sí

      Parámetros requeridos:

        • legajoId: String - Query Param - Id del legajo a editar

        • Todas las propiedades del legajo que se quieran editar - Body de la request

      Respuesta:

        • 200 en caso de éxito confirmando la edición del mismo

      Importante: la edición de un legajo no provoca la emisión de un webhook. Únicamente interacciones desde los flujos de usuario u operaciones desde el backoffice.

       

      Búsqueda

      Método: GET

      Endpoint: https://api..digiventures.la/:applicationVersion/legajos/?query

      Autenticación: Sí

      Parámetros requeridos:

      • query

      /legajos?{date_attribute}=start:{date},end:{date}

      /legajos?{date_attribute}=start:{date}

      /legajos?{date_attribute}=end:{date}

      /legajos?idNumber={string}

      • Glosario:

            • date_attribute:

              • lastActivityAt: última fecha de actividad en flujo

              • createdAt: fecha de creación

              • updatedAt: fecha de última actualización general

              • Importante:

                • el formato de fechas se compone de YYYY-MM-DDTHH:MM:SS.

                • Los documentos son guardados con GMT 0.

            • idNumber:

      Respuesta:

      • 200

      {

      "results": [documents]

      }

      • 500:

      {

      "error": "The operation couldn't be performed, the filter expression is invalid",

      "desc": "operator sta not defined",

      "code": 1

      }

       

      2- ARCHIVOS

      La Api de Archivos permite obtener archivos de los legajos. Por ejemplo: imágenes de facturas de servicios, imágenes de documento de identidad, entre otros.

      Consumo de información

      Los legajos al ser consumidos indican las URLs de cada archivo en las propiedades donde fueron almacenadas.

      Se debe realizar una solicitud a esa URL de la cual se obtendrá un base64 y su nombre de archivo.

       

      Método: GET

      Endpoint: URL provista por la propiedad a consumir.

      Autenticación: sí

      Respuesta:

        • base64

          • type: string

        • filename

          • type: string

      {

      "base64": "base64,example",

      "filename": "photo.png"

      }