MelioraAPI EN
Ранний доступ. Ключи выдаются по запросу. Как получить ключ

Контекст ключа

Какой ключ выполняет запрос, что он видит и какие лимиты у него сейчас.

Маршруты

#Объект ApiContext

Сведения о ключе, которым выполнен запрос: организация, права, охват, лимиты и состояние сбора.

Поля

  • objectstring
    Тип объекта, всегда api_context.
  • key_idstring (uuid)
    Идентификатор ключа. Секрет ключа в ответах не возвращается.
  • organizationobject
    Организация (кабинет), от имени которой действует ключ.
    Вложенные поля
    • idstring (uuid)
      Идентификатор организации.
    • namestring
      Название организации.
  • scopesarray of string
    Права чтения, выданные ключу. До 4 элементов.
  • scopeobject
    Охват ключа: какие пространства и кампании он видит.
    Вложенные поля
    • workspace_modestring
      all: все пространства кабинета; selected: только перечисленные. Значения: all selected
    • workspace_idsarray of string
      Выбранные пространства. Пустой массив при workspace_mode=all. До 50 элементов.
    • workspace_include_futureboolean
      Попадают ли в охват пространства, созданные после выпуска ключа.
    • campaign_modestring
      all: все кампании выбранных пространств; selected: только перечисленные. Значения: all selected
    • campaign_idsarray of string
      Выбранные кампании. Пустой массив при campaign_mode=all. До 500 элементов.
    • campaign_include_futureboolean
      Попадают ли в охват кампании, созданные после выпуска ключа.
    • scope_versioninteger
      Номер версии охвата. Растет при каждом изменении охвата или прав ключа.
  • api_versionstring
    Версия API, всегда v1.
  • expires_atstring (date-time) или null
    Когда ключ перестанет действовать. null, если срок не задан.
  • limitsobject
    Лимиты запросов, действующие для ключа сейчас.
    Вложенные поля
    • key_secondinteger
      Весовых единиц в секунду на ключ.
    • key_minuteinteger
      Весовых единиц в минуту на ключ.
    • org_secondinteger
      Весовых единиц в секунду на организацию, по всем ключам вместе.
    • org_minuteinteger
      Весовых единиц в минуту на организацию, по всем ключам вместе.
    • key_concurrentinteger
      Одновременных запросов на ключ.
    • org_concurrentinteger
      Одновременных запросов на организацию.
    • max_response_bytesstring
      Наибольший размер ответа в байтах (1 МиБ). Длинные страницы сокращаются, данные не теряются. Всегда 1048576.
    • modestring
      normal: обычный режим; emergency: временно сниженные лимиты. Значения: normal emergency
  • collectionobject
    Состояние сбора сохраненной переписки для API.
    Вложенные поля
    • statestring
      running: сбор идет; paused: приостановлен в кабинете; preparing: готовится после включения; degraded: данные могут быть неполными. Значения: running paused preparing degraded
    • enabled_atstring (date-time) или null
      Когда сбор был включен. null, если еще не включен.
    • pause_pendingboolean
      Пауза или возобновление запрошены в кабинете, но еще не применены.
ApiContext
{
  "object": "api_context",
  "key_id": "9b1e7c42-5a6d-4f83-9e0b-2d7c4a8f1e65",
  "organization": {
    "id": "2c8f4a61-7d3e-4b9a-8f21-6a0d5e9c3b17",
    "name": "Пример"
  },
  "scopes": [
    "campaigns:read",
    "events:read",
    "leads:read",
    "messages:read"
  ],
  "scope": {
    "workspace_mode": "all",
    "workspace_ids": [],
    "workspace_include_future": true,
    "campaign_mode": "all",
    "campaign_ids": [],
    "campaign_include_future": true,
    "scope_version": 1
  },
  "api_version": "v1",
  "expires_at": null,
  "limits": {
    "key_second": 5,
    "key_minute": 300,
    "org_second": 10,
    "org_minute": 600,
    "key_concurrent": 5,
    "org_concurrent": 10,
    "max_response_bytes": 1048576,
    "mode": "normal"
  },
  "collection": {
    "state": "running",
    "enabled_at": "2026-10-20T08:00:00.000Z",
    "pause_pending": false
  }
}

#Получить сведения о ключе

GET/v1/me

Возвращает организацию, права, охват и лимиты ключа. Первый запрос для проверки подключения. Доступен ключу с любым набором прав.

Право
любое право чтения
Вес запроса
1

Параметры

Параметров нет.

Ответ

Объект ApiContext.

Особые ошибки

  • scope_required: Ключ не имеет права на это чтение. Для текстов нужен также включенный «Текст сообщений».
  • not_found: Объект не найден или находится вне охвата ключа. Неизвестный путь тоже дает 404.

Общие ошибки описаны в руководстве Ошибки.

Запрос
curl https://api.melioralab.io/v1/me \
  -H "Authorization: Bearer $MELIORA_API_KEY"
Ответ
{
  "object": "api_context",
  "key_id": "9b1e7c42-5a6d-4f83-9e0b-2d7c4a8f1e65",
  "organization": {
    "id": "2c8f4a61-7d3e-4b9a-8f21-6a0d5e9c3b17",
    "name": "Пример"
  },
  "scopes": [
    "campaigns:read",
    "events:read",
    "leads:read",
    "messages:read"
  ],
  "scope": {
    "workspace_mode": "all",
    "workspace_ids": [],
    "workspace_include_future": true,
    "campaign_mode": "all",
    "campaign_ids": [],
    "campaign_include_future": true,
    "scope_version": 1
  },
  "api_version": "v1",
  "expires_at": null,
  "limits": {
    "key_second": 5,
    "key_minute": 300,
    "org_second": 10,
    "org_minute": 600,
    "key_concurrent": 5,
    "org_concurrent": 10,
    "max_response_bytes": 1048576,
    "mode": "normal"
  },
  "collection": {
    "state": "running",
    "enabled_at": "2026-10-20T08:00:00.000Z",
    "pause_pending": false
  }
}