UBLIBOT DOCUMENT API

Understanding UbliBot APIs

Document processing Any document

For UbliBot, documents can be structured, like tabular documents, lists, forms, or scientific charts, semi-structured like a book or a newspaper article, or unstructured like a handwritten note. The UbliBot service is used used in numerous fields, such as:

  • Academia: manuscript, thesis, paper, journal, chart, and technical drawing
  • Media: mock-up, script, image, photography, and newspaper article
  • Administration, law, and politics: application, brief, certificate, commission, constitutional document, form, gazette, identit document, license, manifesto, summons, census, and white paper
  • Business: invoice, request for proposal, proposal, contract, packing slip, manifest, report (detailed and summary), spreadsheet, material safety data sheet, waybill, bill of loading, financial statement, nondisclosure agreement (NDA), mutual nondisclosure agreement, and user guide
  • Geography and planning: topographic map, cadastre, legend, and architectural plan.

 

To process documents right, UbliBot understands a document’s use, purpose, and importance.

  • Apply trained models to understand what a document is all about. 
  • Extracting data from a document into a user defined JSON schema.
  • Validate the extracted data on purpose, completeness and correctness.
  • Making decisions about what a document means and initiate the next step
  • Expose the document in the required format through API.

 

Why does convert any file to any format matter?

A file’s format—the way that it’s saved and encoded—determines what you can do with it and which programs will open it. (You can check its format by looking at the file name’s extension.) Think of each format like a different language, with some only understood by specific platforms and applications. To access any given file, you may need to convert it to a new format. For example, you might need to turn a PDF invoice into an EDI or UBL file – or visa versa.

File conversion is an essential part of interoperability. Take for example the supply chain which plays a major role for companies. UbliBot ensures the provisioning of documents, data, and compliant formats (such as EDI or UBL) between participants, such as customers, suppliers, producers, service providers and customs offices.  Or take mailrooms. Whatever the format, all companies are confronted with incoming correspondence. UbliBot makes a mailroom intelligent, With UbliBit, the original format – be it paper, email, fax, web-form, or something else – is irrelevant as is the document type such as purchase order, complaint, vendor invoice, or request. UbliBot simply handles them all. 

Why Does Intelligent Orchestration Matter?

Centralize all incoming channels

Regardless of the format or origin, UbliBot makes sure every piece of information coming into your organization is processed and directed to the right workflow or person.

Accelerate response and decision times

UbliBot gets the information to the right person quicker and
in a uniform way. 

Improve customer satisfaction and experience

Fast response times and traceability improve the quality of service.

Streamline information circulation

UbliBot enables straight-through processing for standard tasks: from capture to response

Reduce operational cost

Digitization and automation through software diminishes administrative work. Moreover, you save on storage, archiving, maintenance and transportation costs.

Data tracking and transparancy

Unified data enables improved workflows, increased efficiency and the possibility to
monitor and adapt KPI’s.

Secure information

Quickly understand the nature of incoming information and apply the required
levels of security accordingly.

Ensure high-quality data

Let algorithms handle data extraction and classification. This eliminates human
error and ensures the quality of your data.

Turn the unstructured into structured

From emails to a plethora of document formats, a lot of information flowing into your organization is unstructured. UbliBot structures the information.

Quickly find the right documents

Full search on top of digitizing all incoming documents and
information, makes it easy to find the right files.

Compliance without headaches

No human error, clear traceability, automatic application of security levels, and fpoormat-to-format they’re just a few ways UbliBot helps ensure compliance. Moreover, most of it happens automatically so you don’t have to worry anymore and can focus on your company.

API Introduction

The UbliBot API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the UbliBot API to process your documents directly from your file system directories, to interact with (financial / ERP /warehouse) software, or for example to interact with document /trade exchange platforms. Ublion supports asynchronous processing. This means that you executes tasks “in the background” without to wait for the task to finish.

You can find a full list of the UbliBot Document API endpoints here.

 

Not a developer?

Contact us for applications or integration assistance.

Base URL

https://{tenant}-connectapi.ublion.me/

*tenant is the tenant name you entered during registration of your account

Key concepts

The UbliBot APIs are build around documents, data, and format-to-format converters and validators. 

 

Intelligent processing

To process documents right, UbliBot understands a document’s use, purpose, and importance.

  • Apply trained models to understand what a document is all about.
  • Define an JSON schema for a document type 
  • Extracting data from a document into the JSON schema.
  • Validate the data on completeness and correctness.
  • Making decisions about what a document means in a process.

Create your account

When you sign up, UbliBot will ask for:

  • Tenant name: this is the name of your environment. This can be anything. For example your company.
  • Tenancy name: This is the name we use for your domain URL. This should must be unique and may not contain spaces or other special characters.
  • Admin email: Your email address. We call this the Admin email as the first user manages the environment (tenant) and can create extra users or tenants. You can change the name settings once your are logged in.
  • Password: Your password.

After clicking on the Submit button, UbliBot will confirm your registration and send you an email to activate your account.

You can register your account at https://register.ublion.me/account/register

Your credentials are also used for the Swagger (API endpoints).

TEST YOUR CONNECTION

We advise that you test your connection by using the document service to get a list of documents.

For example by sending a POST request to https://{tenant}-connectapi.ublion.me/​api​/services​/app​/Document​/GetAll

Note that the result will be empty as you didn’t process any documents yet.

Authentication

Our APIs enables you to securely exchange your documents between your server and Ublion. The APIs support JSON and require bearer token authentication.

A request will look like this:

https://{tenant}-connectapi.ublion.me/Api/TokenAuth/authenticate

Send a POST request to https://{tenant}-connectapi.ublion.me/Api/TokenAuth/authenticate with the Context-Type=”application/json” header as shown:

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Document upload

Upload your documents using the /api/services/app/Document/Create service.

UbliBot’s document API accepts any file type (max. 2.00 MB each).

Need more? Contact us!

UbliBot has a built in ‘file to base64’ decoder.

The service will return an Internal id when your upload a document. You can use this ID to find the document and state. 

Note: the internal Ublion document ID is returned to you when you used the /api/services/app/Document/Create service.

The service is fully configurable but you only need 3 parameters.

Monitor the Processing State

Make a call to the​/api​/services​/app​/Document​/GetModifiedDocuments service if you want to monitor the processing progress of all your invoice documents. The service will return all internal Ublion document ID’s with status that are changed since your last request.

en_USEN