KKonsol Developers
API referenceApplications

List applications

GET
/integration/v1/applications

Lists the applications your integration key can reach.

Use an application's id as the application_id in the device parameter operations. To find the application a device runs once it is set up for a product and acquirer, filter by product_code and acquirer_id. An acquirer filter matches only applications bound to that acquirer. Applications for every acquirer have acquirer_id null; list them without an acquirer filter. A key without access to applications gets an empty page.

Authorization

integrationKey
headerAuthorizationBearer <token>

Your integration key, sent as Authorization: Bearer nik_<prefix>_<secret>. Konsol issues it.

Query Parameters

page?integer
Range1 <= value
Default1
limit?integer
Range1 <= value <= 100
Default20
q?string

Searches the application name.

Length2 <= length <= 128
sort?string

Orders by a field, ascending, or descending with a - prefix. Ties break on id. Without it the list is in id order.

Value in"created_at""-created_at""updated_at""-updated_at""name""-name""status""-status"
status?string
Value in"active""inactive"
install_identifier?string

The exact package name, for example com.example.payment.

Length1 <= length <= 512
product_code?string

Only the applications that serve this product.

Match^[a-z][a-z0-9_]{0,63}$
acquirer_id?string

Only the applications bound to this acquirer. Applications for every acquirer are not included. An acquirer your key can't reach returns no results.

Formatuuid
acquirer_external_ref?string

The acquirer by your own external_ref, instead of acquirer_id.

Match^\S(.*\S)?$
Length1 <= length <= 128

Response Body

A page of applications

application/json
  1. response
data*array<>
page*integer
Range1 <= value
limit*integer
Range1 <= value <= 100
total_count*integer
Range0 <= value
total_is_capped*boolean
total_pages*integer
Range0 <= value
has_more*boolean
Example Request
curl -X GET 'https://api.konsol.my/integration/v1/applications'
Example Response
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "install_identifier": "string",      "platform": "android",      "status": "active",      "vendor_id": "98232994-9d54-43ee-a280-d7c895362d0c",      "product_code": "string",      "acquirer_id": "32871e4c-4020-4557-b297-174c2d3721f9",      "schema_revision": 0,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "page": 1,  "limit": 1,  "total_count": 0,  "total_is_capped": true,  "total_pages": 0,  "has_more": true}