Guía de integración a nuestra API
Better permite a nuestros clientes utilizar herramientas de inteligencia artificial de manera fácil y segura a través de los servicios de procesamiento de archivos y documentos.
A través de esta integración puedes acceder a los pipelines entrenados por nuestro equipo para que ejecuten labores de automatización de lectura de documentos y archivos no estructurados como pdf y archivos de audio como mp3.
Getting Started
Esta sección expone los elementos para integrarse de manera segura al API de Better para poder acceder a nuestros servicios.
Conceptos
Documento: Obedece a cualquier archivo que contenga información de valor para el cliente la cual quiere ser analizada y proceda por nuestras tecnologías de inteligencia artificial. Normalmente están almacenados en formatos como pdf, jpg, png, o doc.
Customer/cliente: Es la persona o empresa que quiere acceder a nuestros servicios de lectura inteligente para automatizar sus procesos.
Bot: Es un robot de software que permite automatizar tareas repetitivas.
Pipeline: Es el conjunto de bots que se orquestan para automatizar la extracción de información de un único documento. Nuestro producto está diseñado para automatizar flujos de trabajo para el procesamiento de archivos de manera dinámica, es por esto, que para cada uno de nuestros clientes, diseñamos un flujo único para el procesamiento de cada uno de los documentos que quieran automatizar.
Url pre-firmada: Es una URL que ha sido generada con anticipación y que incluye información de autenticación o autorización. Estas URLs son únicas y temporales, y se utilizan comúnmente para proporcionar acceso seguro a recursos en línea, como archivos almacenados en servicios de almacenamiento en la nube. En el contexto de nuestra API, una URL pre-firmada se utiliza para entregar un documento específico a nuestro sistema permitiendo así que lo podamos procesar.
Empieza a procesar tus documentos con BETTER
1. Regístrate
Contacta con nuestros asesores comerciales
2. Desarrollar, entrenar y desplegar modelo de inteligencia artificial
Informar a nuestro equipo de producto el tipo de documento que se quiere procesar junto con los campos a extraer. El equipo de producto creará tu cuenta en el sistema y desplegará tu modelo entrenado en producción indicando el pipeline_id que se debe utilizar al invocar el API.
3. Integrate a nuestra API
Una vez el pipeline se encuentre en producción puedes hacer la integración para consumir nuestros servicios directamente desde tu aplicación.
4. Go live
Empieza a procesar tus documentos y automatiza tus procesos de negocio
Modelo de integración
A continuación detallamos el flujo de información del modelo expuesto por Better para que los clientes puedan acceder a nuestros servicios.
1. Solicitar url-pre-firmada: El paso de solicitar una URL pre-firmada implica utilizar nuestra API RESTful en donde se debe enviar dos recursos clave: el pipeline y el customer. Los clientes deben realizar una solicitud GET a nuestro servicio, y como respuesta, recibirán la URL pre-firmada junto con un job_id. Esta URL pre-firmada está vinculada específicamente al documento que se va a procesar y está protegida mediante autenticación o autorización. El job_id proporcionado permite realizar un seguimiento del estado del procesamiento del documento asociado.
Endpoint:
https://dfvmsqv3g1.execute-api.us-east-1.amazonaws.com/v1/{customer}/{pipeline}
customer: Parámetro entregado por Better; una vez creamos la cuenta en nuestro sistema Intelektus
pipeline: Parámetro entregado por Better; recuerda que un mismo cliente puede procesar varios tipos de documentos, y para cada uno de ellos se diseña un pipeline único, es importante que el cliente determine cuál es el pipeline que quiere invocar y asegurarse que dicho pipeline esté previamente desplegado en producción.
Debes solicitar un API-KEY para poder acceder a nuestra api y enviarla dentro del header indicando como Key el siguiente valor “x-api-key” y como value lel token que te compartimos por un canal seguro.
2. Entregar documento: Debes usar la url entregada en el proceso anterior para entregarnos el documento que quieres procesar a través de una operación PUT y especificando el archivo binario que quieres que procesamos. Como resultado recibirás una respuesta 200 lo que indica que el documento fue recibido.
3. Respuesta webhook: Los webhooks te permiten recibir notificaciones programáticas de Better-Intelektus sobre cambios en tus datos en tiempo real.
​
En lugar de requerirte extraer información a través de nuestra API, los webhooks enviarán información a tu Endpoint . Cuando se active el evento de finalización de proceso , Better-Intelektus enviará esta notificación como una solicitud HTTP POST, con un cuerpo JSON, al Endpoint que especifiques.
Endpoint afuera de Better
Endpoint Url
Una URL de punto final es el Endpoint HTTP donde se envían los eventos preferidos. Podemos enviarlos solo a una URL completa, válida y públicamente accesible.
​
ejemplo:
​
https://tu.dominio.web.com/{job_id}
HTTP Auth nombre de usuario y clave (cuando se requiera)
HTTP auth username y HTTP auth password son opcionales dependiendo la configuración de tu servidor. El servicio de Webhook enviará credenciales básicas de autenticación en el header de cada solicitud HTTP.
Formato de webhook
En el body de la petición enviaremos la información extraída durante el pipeline bajo la llave fields: dentro de ella encontraras un diccionario de cada uno de los campos que solicitaste para la extracción.
La política de reintento de webhooks es la siguiente:
​
En caso de que el intento original de enviar la notificación falle (debido a recibir un código de respuesta no-2XX o exceder el tiempo de espera de 10 segundos), intentaremos 3 veces más: después de 3, 30 y 150 segundos. Si aún falla en cada uno de esos intentos, se contabiliza como una entrega no exitosa.