Working with the Yandex Tracker API

Plugins work with the same public Tracker API that is available to external apps. The entire supported API contract is available through trackerApi.

Whether a particular action can be performed via the API depends on the plugin's permissions and on the access rights of the user on whose behalf the requests are made.

To work with the Tracker API, the SDK provides the trackerApi object:

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

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

For endpoints that accept file uploads, the attachment is placed in the file field:

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

At the beginning, in square brackets, you specify the path from the Tracker REST API, followed by the parameters from the REST API.

API error codes

When calling methods, the platform may return an error with a code. Constants are exported from the package:

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';