Authentication

Lucidtech APIs require you to authenticate using the OAuth2 protocol. Our SDKs will typically handle authentication for you but should you wish to use the REST API, you would need to do this yourself. Here is a brief introduction to get you started
Credentials
You should already have acquired a client id, client secret and api key before continuing. The client id and client secret will be used to get an access token from the auth endpoint and the api key will be used together with the access token to authorize to the API.
Unless specified otherwise in the credentials file you have received, the endpoint for authentication is https://auth.lucidtech.ai and the endpoint for the API is https://api.lucidtech.ai​
Getting an access token
To acquire an access token we need to ask the auth endpoint with our client id and client secret for access. This is done by performing a HTTP POST request to the token endpoint /oauth2/token with two headers provided. One header should be 'Authorization' with base64 encoded client_id and client secret and one header should be 'Content-Type' which will always contain the same value 'application/x-www-form-urlencoded'.
Header name
Header value
Authorization
Basic Base64Encode(client_id:client_secret)
Content-Type
application/x-www-form-urlencoded
Read more about Base64Encode here​
Since we are dealing with 'client_credentials' we need to specify this in the url as a query parameter. The final URL to make the request to is https://auth.lucidtech.ai/oauth2/token?grant_type=client_credentials​
Here is an example getting access token using curl in bash.
1
$ credentials="<your client id here>:<your client secret here>"
2
$ base64_encoded_credentials=`echo -n $credentials | base64 -w 0`
3
$ curl -X POST https://auth.lucidtech.ai/oauth2/token?grant_type=client_credentials -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic $base64_encoded_credentials"
Copied!
If everything is working as expected, the response should look similar to the following
1
{
2
  "access_token":"eyJ...",
3
  "expires_in":3600,
4
  "token_type":"Bearer"
5
}
Copied!
The access token will expire after some time, currently after 3600 seconds (1 hour). When the token expires you will need to get a new access token using the same procedure.
Calling the API
Upon successfully acquiring access token from previous step, we are ready to call the API! To do that we need to provide two headers to the API. One header 'x-api-key' with our api key and one header 'Authorization' with the newly acquired access token.
Header name
Header value
Authorization
Bearer <your access token here>
x-api-key
<your api key here>
1
$ api_key="<your api key here>"
2
$ access_token="<you access token here>"
3
$ curl https://api.lucidtech.ai/v1/documents -H "x-api-key: $api_key" -H "Authorization: Bearer $access_token"
Copied!
Using an SDK
Our SDKs will handle acquiring access token for you. The only thing you need to do is put the credentials in a file in the correct location on your computer and the SDK will discover them. The credentials file should be placed on the following location based on the OS you are running
Operating System
Location
Linux/Mac
~/.lucidtech/credentials.cfg or $HOME/.lucidtech/credentials.cfg
Windows
%USERPROFILE%.lucidtech\credentials.cfg or %HOME%.lucidtech\credentials.cfg
The credentials.cfg file should look like the following
1
[default]
2
api_key = <your api key here>
3
client_id = <your client id here>
4
client_secret = <your client secret here>
5
auth_endpoint = auth.lucidtech.ai
6
api_endpoint = https://api.lucidtech.ai/v1
Copied!

Docker samples

Next - Getting Started

Quotas

Last modified 9mo ago

Copy link

Contents

Credentials

Getting an access token

Calling the API

Using an SDK