API Invocation Method
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:
If partner want to integrate with Klavi Klaas via mTLS, the host is:
|
resource-path | Resource path, i.e. API access path. APIs with different functions have different resrouce path. 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. |
Parameter Name | Type | Required | Description |
|---|---|---|---|
partner_code | String | Yes | Unique identifier for partner |
partner_token | String | Yes | Partner credential for authentification of API access |
All Klavi APIs communicate through HTTPS, providing a high security communication channel. We also support communication through mTLS, if required. For a more detailed description of mTLS, see the following link. Secure data transmission through mTLS
Supported HTTP request methods:POST and GET.
💡Note:
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.
UTF-8 coding.
