Open Docs Navigation
GET STARTED
SMART TOOLS
SMART TOOLS REST API
USE CASES
ACCOUNT
Get your token
1. Before you can use any of the APIs, you need to log in to your Laigo account or, if you don’t have one, create a new one.
2. For creating the token, please visit our platform and go to API-Client Page to create and copy your client credentials.
2. Once you logged in, then you can start to create your client secret and client id by selecting the API page on the left sidebar of the dashboard.
3. For generating your client_id and client_secret you can click on the button ‘Request new’ then you can have your credentials that you can use for creating a token.
4. Create an access token.
To request access tokens, an application must make a POST request with the following multipart form data to the token URI: grant_type=client_credentials.
The application must pass basic HTTP auth credentials using the client_id as the user and client_secret as the password access tokens are obtained by calling the https://account.laigo.io/realms/SmartTools/protocol/openid-connect/token endpoint, and the required secrets are available in the API tab for your need.
*the route for generating the tokens is not working at the moment, because the work at test server is still going on
Create an access token using GET
https://account.laigo.io/realms/SmartTools/protocol/openid-connect/token
Get your sample code
curl -u {client_id}:{client_secret} -d grant_type=client_credentials
https://account.laigo.io/realms/SmartTools/protocol/openid-connect/token
import requests
token_url = 'https://account.laigo.io/realms/SmartTools/protocol/openid-connect/token'
data = {'client_id': '<clientId>', 'client_secret': '<clientSecret>', 'grant_type': 'client_credentials'}
result = requests.post(token_url, data = data)
print(result.text)
| Parameters | Description |
|---|---|
|
client_id |
The ClientId that has been generated for this function.
|
|
client_secret |
The ClientSecret that has been generated for this function. |
|
grant_type |
Here you put your client credentials |
Expected response
{
"access_token": "USVb1nGO9kwQlhNRRnI4iWVy2UV5j7M6h7",
"token_type": "Bearer",
"expires_in": 86400
}
HTTP Status Codes
| Code | Description |
|---|---|
|
200 |
Request was successfully |
|
400 |
Bad Request - missing or wrong Parameter
(file too large, wrong filetype, no processing
possible) |
|
401 |
Unauthorized (could be wrong token or credentials) |
Uploading a new document
Once your access tokens are obtained by following the steps shown above the required secrets are available in the API tab for your task.
In our example we will show how to use the API call to the smartICR tool.Â
First you have to make a POST request to the following route, since you are uploading a new document.
POST
https://use.laigo.io/api/FileUpload/v1/Upload/ICR
| Parameters | Description |
|---|---|
|
accessToken |
A JWT issued to your application by the Laigo identity provider.
|
|
file |
The file for uploading
|
|
email |
If you want to sent the result to your email, you can define the destination email with this parameter
|
|
outputFormats
|
As output format you can choose PDF and/ TEXT
(e.g. outputFormats=PDF,TEXT) |
|
languageHint |
If you prefer the detection in a special language, you can force to use a language. Default Language is English. For choosing a Language, use the ISO-Langauge Code – 639-1 |
curl -X POST \
https://laigo.io/api/FileUpload/v1/Upload/ICR \
-H 'Authorization: Bearer my-api-key-here' \
-F file=@/path/to/your/file.png
import requests
url = "https://laigo.io/api/FileUpload/v1/Upload/ICR"
with open("/path/to/my/file", "rb") as myfile:
files = {"document": myfile}
headers = {"Authorization": "Bearer my-api-key-here"}
response = requests.post(url, files=files, headers=headers)
print(response.text)
<form onsubmit="laigoSubmit(event)" >
<input type="file" id="my-file-input" name="file" />
<input type="submit" />
</form>
<script type="text/javascript">
const laigoSubmit = (evt) => {
evt.preventDefault()
let myFileInput = document.getElementById('my-file-input');
let myFile = myFileInput.files[0]
if (!myFile) { return }
let data = new FormData();
data.append("file", myFile, myFile.name);
let xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://laigo.io/api/FileUpload/v1/Upload/ICR");
xhr.setRequestHeader("Authorization", "Bearer my-api-key-here");
xhr.send(data);
}
</script>
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://laigo.io/api/FileUpload/v1/Upload/ICR',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('file'=> new CURLFILE('<your-file-here>')),
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer <your-token-here>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Once the input file is send to the API, the file will be send to the OCR. After processing you will receive a searchable PDF and/or a textfile with the extracted text included.
Example Response
The result is the jobid, you can use later for getting the result.
"754a9eff-2633-47d6-ab10-f6b18da1da4f"Get a result as JSON
If you want to have to request the extracted text in a JSON, you can request the following API route.
GET
https://use.laigo.io/api/Result/v1/JobResults/<jobid>json
| Parameters | Description |
|---|---|
|
accessToken |
A JWT issued to your application by the Laigo identity provider.
|
|
fileName |
The path to the image file to use as input. |
Example response
{
"files": [
{
"inputFileName": "test.pdf",
"size": 59472, "pageCount": 1,
"content": "Hello World!"
}
]
}
Get a result as ZIP
If you want to get the result as files (searchable PDF + Textfile), you can request the following API route.
GET
https://use.laigo.io/api/Result/v1/JobResults/<jobid>zip
| Parameters | Description |
|---|---|
|
accessToken |
A JWT issued to your application by the Laigo identity provider.
|
|
jobID |
This is the jobid you get as response after uploading a file. |
Example Response (ZIP):
filebytes
| Status code | Message |
|---|---|
|
200 |
Request was successfully
|
|
201 |
Created – Upload was successfully |
|
201 |
Bad Request – missing or wrong Parameter |
While using smartICR API there could be some error messages, that are done for file validation checking:
| Error Message | Description |
|---|---|
|
Please send the correct input file format!
|
The file format is not (PNG,JPG) or (PDF) |
|
Please send a file that doesn’t exceed the size limit! |
The file size is more than the allowed limit (number) |
|
Please make sure that your file doesn’t contain any suspicious malware data! |
The file contains suspicious data, then security check system warns you |
|
You have ran out of Laigos, renew your subscription to continue using Laigo APIs! |
All of your Laigos are used, please renew your subscription |
Setup Your Adapters
On the left sidebar you have section for setting up your Adapters. You have different adapters such as: IMAP, WebDev or even you can also configure your own adapter through the dashboard functionalities.
