Get Access Token

Endpoint Name: get_access_token

Request type : POST

Authorization : None

Endpoint Details: The get_access_token endpoint will be used to get the access token and the refresh token, The validity of the access token will be some minutes, and the refresh token will be days.

Method

URL

POST

URL/access/klearstack/get_access_token

Request Body

Parameters

Description

Required or Optional

username

Username of the user to be logged in

Required

password

Password of the user

Required

company_name

Name of the company for which the user is logging in

Required

Request Code Samples

Shell

  • Request Body

curl -X POST URL/access/klearstack/get_access_token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "username=Replace_User_Name_Here&company_name=Replace_Company_Name_Here&password=Replace_Password_Here"

Python

  • Request Body

import requests

# API URL
url = "URL/access/klearstack/get_access_token"

# Request payload
data = {
    'username': 'Replace_User_Name_Here',
    'company_name': 'Replace_Company_Name_Here',
    'password': 'Replace_Password_Here'
}

# Make the POST request
response = requests.post(url, data=data)

# Print the response
if response.status_code == 200:
    print(response.json())
else:
    print("Error:", response.text)

Java

  • Request Body

import okhttp3.*;

import java.io.IOException;

public class ApiRequestExample {

    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        // Form data (username, company_name, password)
        RequestBody formBody = new FormBody.Builder()
                .add("username", "Replace_User_Name_Here")
                .add("company_name", "Replace_Company_Name_Here")
                .add("password", "Replace_Password_Here")
                .build();

        // Create the request
        Request request = new Request.Builder()
                .url("URL/access/klearstack/get_access_token")
                .post(formBody)
                .addHeader("Content-Type", "application/x-www-form-urlencoded")
                .build();

        // Execute the request and handle the response
        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println("Response: " + response.body().string());
            } else {
                System.out.println("Error: " + response.body().string());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

Nodejs

  • Request Body

var request = require('request');

const form_data = {
  'username': 'Replace_User_Name_Here',
  'company_name': 'Replace_Company_Name_Here',
  'password': 'Replace_Password_Here'
};

const options = {
  url: 'URL/access/klearstack/get_access_token',
  formData: form_data,
  headers: {
    'Content-Type': 'application/x-www-form-urlencoded'
  }
};

request.post(options, function(err, httpResponse, body) {
  if (err) {
    console.error('Request failed:', err);
    return;
  }

  console.log('Response:', body);
});

Javascript

  • Request Body

// Create a new FormData object
var data = new FormData();
data.append('username', 'Replace_User_Name_Here');
data.append('company_name', 'Replace_Company_Name_Here');
data.append('password', 'Replace_Password_Here');

// Create a new XMLHttpRequest object
var xhr = new XMLHttpRequest();

// Set up the request
xhr.addEventListener("readystatechange", function () {
    if (this.readyState === this.DONE) {
        console.log(this.responseText); // Log the response
    }
});

// Open the request
xhr.open("POST", "URL/access/klearstack/get_access_token");

// Set the Authorization header (if necessary)
xhr.setRequestHeader("Authorization", "Basic " + btoa("REPLACE_API_KEY:"));

// Send the request
xhr.send(data);

API Response

Status code

Example Response

200

{

"refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTY1NjU3NjA5OCwiaWF0IjoxNjU2NTcdGkiOiI1ZmEzNGM4YjUyOGI0OWM3OWQzNjk5ZWJlNDRlYzUwZiIsInVzZXJfaWQiOjI2fQ.kvpMWPuxenw2c55nucfQCxHLipiO4DhK2TC5NKpJZEk",

"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjU2NTc2MDM4LCJpYTY1NzU5MTgsImp0aSI6IjQwMWZlYmJhODg4NDQ1MmRhN2Q3ZTA5ZjEwZmYwOWFkIiwidXNlcl9pZCI6MjZ9.sjU6iVbRRp7dTDt-l4rj7K7tKpPpaL7yskjstAUn2Zs",

"release_version": “7.8.9”

}

500

One or Many Required parameters from company name must be missing, E.g error “Company Name”,

Last updated