---
title: Quick Start
slug: klaas/quick-start
description: Learn about the request URI structure and public parameters required for accessing Klavi APIs in this informative document. Understand the HTTPS communication protocol with mTLS support and discover the supported HTTP methods, content type requirements, a
docTags: 
createdAt: 2023-06-16T09:55:43.000Z
---

## Request URI

The request URI consists of the following parts:

`{URI-scheme}://{Host}/{resource-path}?{query-string}`

Parameter description in URI:

| **Parameter**   | **Description**                                                                                                                                                                                                                                                                                   |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `URI-scheme`    | All APIs use `HTTPS` protocol.                                                                                                                                                                                                                                                                    |
| `Host`          | Different environments have different host:<br />- Sandbox: **`api-sandbox.klavi.ai`**<br />- Production: **`api.klavi.ai`**<br />If partner want to integrate with Klavi Klaas via mTLS, the host is:<br />- Sandbox: **`mtls-api-sandbox.klavi.ai`**<br />- Production: **`mtls-api.klavi.ai`** |
| `resource-path` | Resource path, i.e. API access path. APIs with different functions have different resrouce path. <br />For example, the resource-path of the category API is `/klaas/transaction/v2/category`.                                                                                                    |
| `query-string`  | Query parameters are optional. Not every API has query parameters. Query parameters need to be preceded by a "?", The form is `parameter name=parameter value`, for example, `?limit=10`, which means no more than 10 pieces of data can be queried.                                              |

## Public parameter

| **Parameter Name** | **Type** | **Required** | **Description**                                       |
| ------------------ | -------- | ------------ | ----------------------------------------------------- |
| `client_id`        | String   | Yes          | Unique identifier for partner                         |
| `client_secret`    | String   | Yes          | Partner credential for authentification of API access |

## Communication protocol

All Klavi APIs communicate through HTTPS or or mTLS over HTTPS, providing a high security communication channel.

## Request method

Supported HTTP request methods:`POST` and `GET`.

:::hint{type="info"}
💡**Note:&#x20;**

For GET method, only content type: application/x-www-form-urlencoded protocol format is supported. For POST method, only content type: application/JSON is supported at present.
:::

## Character encoding

UTF-8 coding.