Списки
v1.0.0
OpenAPI 3.1.0

КлиентРадар API

Подключение к КлиентРадар

Создайте ключ в кабинете: Доступ к API → Создать ключ. Ключ привязан к одному клиенту и выбранным разрешениям. Введите ключ самостоятельно в поле Bearer Token. Передавайте его только в заголовке Authorization: Bearer ВАШ_КЛЮЧ. Сессия кабинета не авторизует запросы к API. Ключ не сохраняется между открытиями документации.

Начните с GET /me: ответ содержит ID доступного клиента (tenant) и разрешения ключа. Доступ ограничен действующим членством; чужие и недоступные записи возвращают 404. Отозванный или истёкший ключ возвращает 401; недостаточные разрешения — 403.

Списки

per_page: от 1 до 100, по умолчанию 25. Передавайте следующий cursor без изменений или используйте links.next. Это курсорная пагинация: общего количества страниц и total нет. Даты полученных номеров (received_on) — по Москве.

Запросы и ошибки

Указывайте Accept: application/json; для POST/PATCH — также Content-Type: application/json. Успешный ответ содержит success: true и data. Ошибка содержит success: false, error.code, error.message; при 422 также errors по полям. Лимит пользователя: 120 запросов в минуту; для операций записи дополнительно 20 в минуту. При 429 соблюдайте Retry-After.

Try It выполняет настоящий запрос. POST, PATCH и DELETE изменяют данные. Для знакомства используйте отдельного тестового клиента и ключ с минимальными разрешениями.

Server:https://lk.knam.pro/api/v1
Client Libraries
Shell Curl

Баланс

​
Баланс Operations

Баланс клиента

​

Разрешения ключа (нужны все): balance:read.

Path Parameters

  • tenant
    Type: integer
    min:  
    1
    required

    Integer numbers.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/tenants/{tenant}/balance
curl https://lk.knam.pro/api/v1/tenants/1/balance \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "success": true,
  "data": {
    "credited_units": 1,
    "debited_units": 1,
    "received_contact_units": 1,
    "available_units": 1
  }
}

Успешный ответ

Операции по балансу

​

Разрешения ключа (нужны все): balance:read.

Path Parameters

  • tenant
    Type: integer
    min:  
    1
    required

    Integer numbers.

Query Parameters

  • per_page
    Type: integer
    min:  
    1
    max:  
    100

    Integer numbers.

  • cursor
    Type: string | null
    max length:  
    2048

    Непрозрачный курсор из meta.next_cursor или ссылки links.next.

  • type
    Type: enumnullable
    values
    top_upmanual_debit

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/tenants/{tenant}/transactions
curl https://lk.knam.pro/api/v1/tenants/1/transactions \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "success": true,
  "data": [
    {
      "id": 1,
      "type": "top_up",
      "units": 1,
      "reason": "string",
      "occurred_at": null
    }
  ],
  "links": {
    "first": null,
    "last": null,
    "prev": null,
    "next": null
  },
  "meta": {
    "path": "string",
    "per_page": 1,
    "next_cursor": null,
    "prev_cursor": null
  }
}

Успешный ответ