If you're new to APIs, this guide explains basic API terminology and logical principles that will be used in further API documentation.

API

An API (Application Programming Interface) is a way for different software applications to talk to each other. It acts as a bridge that allows one system to request and exchange data with another.

Postman

Postman is a popular tool used for testing, developing, and managing APIs. With Postman, you can:

• Send API requests
• View responses returned by an API in a structured format (JSON, XML, etc.)
• Use API authentication with API tokens
• Automate repetitive tasks by running scripts
• Save & share requests by organizing API requests into collections

API request & response

An API request is like ordering food at a restaurant. You tell the kitchen (API) what you want by providing specific details (parameters). The kitchen processes your request and sends back the meal (response).

An API request usually includes:

• Endpoint (URL) – the address where the request is sent
• Method – the request type (=action): GET, POST, PUT, DELETE
• Headers – extra information (e.g., authentication)
• Body – data sent with the request (e.g., login details)

📌 Example: you request weather data in Tallinn from an API, and the API responds with the current temperature and forecast.

GET https://api.weather.com/data?city=Tallinn

API endpoint

An endpoint is a specific URL where an API (Application Programming Interface) receives requests. It’s like a door that allows different systems to communicate by sending and receiving data.

📌 Example in Postman:

• GET request to an endpoint: if you send a GET request https://launcher.mlx.yt:45001/api/v1/version in Postman and click "Send," the API will the app version.
• POST request to an endpoint: if you send a POST request to https://launcher.mlx.yt:45001/api/v2/profile/quick with user details in the body, the API will start a quick profile

HTTP request types

APIs use HTTP request types (also called methods) to specify the type of action needed:

📌 Example: 

• https://launcher.mlx.yt:45001/api/v1/version is a GET request as it returns info
• https://launcher.mlx.yt:45001/api/v2/profile/quick is a POST request as it creates a new quick profile

API token

An API token is like a digital key that allows you to securely access an API. When you make a request to the API, you need to include this token, so the system knows who you are and whether you're allowed to perform the action.

📌 Example: to send a new request in Postman, you first need to copy an API token to the authorization field to authenticate:

Command Line Interface (CLI)

The CLI allows you to interact with Multilogin X through the command-line interface, facilitating automation without the need for a graphical user interface. You can send API requests, manage services, and automate tasks directly from the terminal using commands. 

📌 For example, using cURL (a common CLI tool for API requests), you can send a GET request like this:

curl -X GET "https://api.example.com/users" -H "Authorization: Bearer YOUR_API_TOKEN"

Rate limits & RPM (requests per minute)

APIs have limits on how many requests you can send within a certain time to prevent overuse – this is called Rate Limiting, and it's often measured in RPM (Requests Per Minute). Multilogin RPM limit depends on the subscription type; check the pricing page for details.

How does RPM work?

• RPM tells you how many requests you can send in one minute
• Each time you ask the API to do something (like fetching data or updating a record), it counts as one request

📌 Example: if your limit is 100 RPM, you can send up to 100 requests per minute. If you hit your limit, try waiting a minute or upgrading your plan to send more requests!

WebDriver

A WebDriver is a tool that allows automated interaction with web browsers. It controls the browser just like a real user would – clicking buttons, filling forms, and navigating pages. Multilogin X supports integration with automation libraries like Selenium, Puppeteer, and Playwright, enabling tasks such as form filling, CAPTCHA solving, and web scraping.

Selenium

The most popular WebDriver is Selenium WebDriver, which works with browsers like Chrome, Firefox, and Edge: it allows automation using programming languages like Python, Java, JavaScript, and C#

📌 Selenium WebDriver code in Python example:

from selenium import webdriver

driver = webdriver.Chrome()
driver.get("https://example.com")
print(driver.title)
driver.quit()

Puppeteer

Puppeteer is a Node.js library developed by Google that allows you to automate and control web browsers (like Chrome and Chromium) programmatically. It provides a high-level API to interact with web pages—clicking buttons, filling forms, scraping data, generating PDFs, and more.

📌 Puppeteer in JavaScript example:

const puppeteer = require('puppeteer');

(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com');
  await page.screenshot({ path: 'example.png' });
  await browser.close();
})();

Playwright

A modern open-source automation framework for web testing, developed by Microsoft. It allows you to control web browsers like Chrome, Firefox, and Edge programmatically, just like a real user.

📌 Playwright in JavaScript example:

const { chromium } = require('playwright');

(async () => {
  const browser = await chromium.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com');
  console.log(await page.title());
  await browser.close();
})();