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

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

Для работы с API Трекера Используйте SDK. Он предоставляет объект trackerApi.v3 — типизированный прокси над HTTP-методами Tracker. Ключи — пути эндпоинтов из OpenAPI (@weavix/tracker-api-types); IDE предоставляет автодополнение и JSDoc.

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

// GET — возвращает { data, headers }
const { data: issue } = await trackerApi.v3.get['/issues/{id}']({
  pathParams: { id: 'KEY-1' },
  queryParams: { expand: ['COMMENTS'] },
});

// POST
const { data: newIssue } = await trackerApi.v3.post['/issues']({
  bodyParams: { queue: { key: 'TASK' }, summary: 'Новая задача' },
});

// PATCH
await trackerApi.v3.patch['/issues/{id}']({
  pathParams: { id: 'KEY-1' },
  bodyParams: { summary: 'Обновленное название' },
});

// DELETE
await trackerApi.v3.delete['/issues/{id}']({
  pathParams: { id: 'KEY-1' },
});

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

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

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

trackerApi.v3

Метод Параметры Описание
get[path](payload) pathParams, опционально queryParams GET-запрос
post[path](payload) bodyParams, опционально pathParams, queryParams POST-запрос
put[path](payload) аналогично post PUT-запрос
patch[path](payload) аналогично post PATCH-запрос
delete[path](payload) pathParams, опционально queryParams DELETE-запрос

Все методы возвращают Promise<{ data, headers }>, где data типизирован согласно ответу эндпоинта.

Коды ошибок 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/tracker-plugin-sdk-react';
Константа Код Описание
PLUGIN_ID_OR_SLOT_NOT_PROVIDED 1000 Не переданы обязательные параметры инициализации плагина
PLUGIN_ID_IS_NOT_CORRECT 1001 Неверный или несовпадающий pluginId
VALIDATION_ERROR 1002 Ошибка валидации запроса
METHOD_NOT_SUPPORTED 1003 Метод не поддерживается
MISSING_REQUIRED_SCOPE 1004 Недостаточно прав (scope)
UNKNOWN_ERROR 6666 Неизвестная ошибка
Следующая