API Integration Guide
Better enables our customers to easily and securely use AI tools across file and document processing services.
Through this integration you can access the pipelines trained by our team to execute automated tasks for reading documents and unstructured files such as PDFs and audio files such as MP3s.
Getting Started
This section outlines the elements to securely integrate with the Better API in order to access our services.
Concepts
Document : Any file containing valuable information for the client that is to be analyzed and processed by our artificial intelligence technologies. They are usually stored in formats such as pdf, jpg, png, or doc.
Customer: This is the person or company that wants to access our intelligent reading services to automate their processes.
Bot: It is a software robot that allows you to automate repetitive tasks.
Pipeline: This is the set of bots that are orchestrated to automate the extraction of information from a single document. Our product is designed to automate workflows for dynamic file processing, which is why, for each of our clients, we design a unique flow for processing each of the documents they want to automate.
Pre-signed URL: A URL that has been generated in advance and includes authentication or authorization information. These URLs are unique and temporary, and are commonly used to provide secure access to online resources, such as files stored on cloud storage services. In the context of our API, a pre-signed URL is used to deliver a specific document to our system, allowing us to process it.
Start processing your documents with BETTER
1. Register
Contact our sales consultants
2. Develop, train and deploy artificial intelligence model
Inform our product team of the type of document you want to process along with the fields to be extracted. The product team will create your account in the system and deploy your trained model to production indicating the pipeline_id to be used when invoking the API.
3. Integrate with our API
Once the pipeline is in production, you can integrate it to consume our services directly from your application.
4. Go live
Start processing your documents and automate your business processes
Integration model
Below we detail the information flow of the model presented by Better so that clients can access our services.
1. Request pre-signed-url: The step of requesting a pre-signed URL involves using our RESTful API where two key resources must be sent: the pipeline and the customer. Clients must make a GET request to our service, and in response, they will receive the pre-signed URL along with a job_id. This pre-signed URL is specifically linked to the document to be processed and is protected by authentication or authorization. The job_id provided allows tracking the processing status of the associated document.
Endpoint:
https://dfvmsqv3g1.execute-api.us-east-1.amazonaws.com/v1/{customer}/{pipeline }
customer : Parameter provided by Better; once we create the account in our Intelektus system
pipeline : Parameter provided by Better; remember that a single client can process several types of documents, and a unique pipeline is designed for each of them. It is important that the client determines which pipeline they want to invoke and ensure that said pipeline is previously deployed in production.
You must request an API-KEY to access our API and send it within the header indicating the following value “x-api-key” as Key and the token that we share with you through a secure channel as value.
2. Deliver document: You must use the URL provided in the previous process to deliver the document you want to process through a PUT operation and specifying the binary file you want us to process. As a result, you will receive a 200 response indicating that the document was received.
3. Webhook Response: Webhooks allow you to receive programmatic notifications from Better-Intelektus about changes to your data in real time.
Instead of requiring you to pull information through our API, webhooks will send information to your Endpoint . When the Process Termination event is triggered, Better-Intelektus will send this notification as an HTTP POST request, with a JSON body, to the Endpoint you specify.
Endpoint afuera de Better
Endpoint Url
An endpoint URL is the HTTP endpoint where preferred events are sent. We can send them only to a fully qualified, valid, and publicly accessible URL.
example:
https://your.domain.web.com/{job_id}
HTTP Auth username and password (when required)
HTTP auth username and HTTP auth password are optional depending on your server configuration. The Webhook service will send basic authentication credentials in the header of each HTTP request.
Formato de webhook
In the body of the request we will send the information extracted during the pipeline under the fields key: inside it you will find a dictionary of each of the fields you requested for extraction.
The webhook retry policy is as follows:
In case the original attempt to send the notification fails (due to receiving a non-2XX response code or exceeding the 10-second timeout), we will try 3 more times: after 3, 30, and 150 seconds. If it still fails on each of those attempts, it is counted as an unsuccessful delivery.