---
metadata:
  - name: generator
    content: Diplodoc Platform v5.54.5
  - property: og:type
    content: article
  - property: article:section
    content: Платформа плагинов
  - property: og:title
    content: Работа с API Яндекс Трекера
  - property: article:tag
    content: Техническая инструкция
alternate:
  - https://yandex.ru/support/tracker/en/plugins/publicApi.md
  - https://yandex.ru/support/tracker/ru/plugins/publicApi.md
  - href: ru/plugins/publicApi.md
    type: text/markdown
    title: Markdown version
  - href: ../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/ru/llms.txt


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

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

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

Для работы с API Трекера [SDK](tools/sdk) предоставляет объект `trackerApi`:

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

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

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

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


В начале, в квадратных скобках, указывается путь из [REST API Трекера](https://yandex.ru/support/tracker/ru/api-ref/about-api.md), потом параметры из REST API.

## Коды ошибок API {#error-codes}

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

```typescript
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 | Неизвестная ошибка. |