Работа с API Яндекс Трекера

Плагин может взаимодействовать с данными Трекера через его публичный API. Возможность выполнять те или иные действия через API зависит от прав самого плагина и прав доступа пользователя, от имени которого выполняются запросы.

Для работы с API Трекера SDK предоставляет объект trackerApi:

import { trackerApi } from '@weavix/sdk-react';

const issue = await trackerApi.v3.get['/issues/{id}']({
  pathParams: { id: 'KEY-1' },
  queryParams: { expand: ['COMMENTS'] },
});

Для эндпоинтов, в которые можно загружать файлы, вложение помещается в поле file:

const atttachment = await trackerApi.v3.post['/attachments']({
  bodyParams: { filename },
  file,
});

В начале, в квадратных скобках, указывается путь из REST API Трекера, потом параметры из REST API.

Коды ошибок API

При вызовах методов хост может вернуть ошибку с кодом. Константы экспортируются из пакета:

import {
  METHOD_NOT_SUPPORTED,
  MISSING_REQUIRED_SCOPE,
  PLUGIN_ID_IS_NOT_CORRECT,
  PLUGIN_ID_OR_SLOT_NOT_PROVIDED,
  UNKNOWN_ERROR,
  VALIDATION_ERROR,
} from '@weavix/sdk-react';