OpenAPI-контракт как машиночитаемый reference для API

YAML-спека — поверхность для скачивания контракта в генераторы клиентов и API explorer.

Держите публичные docs и spec синхронизированными: если они расходятся, доверие падает быстро.

Эта страница объясняет работу со spec, а не дублирует вручную каждый endpoint.

Раздел

Где лежит spec

Текущий исходный файл: docs/openapi/external-statistics-v1.yaml.

Импорт в Postman или другой клиент

1. Скачайте YAML-файл.
2. Импортируйте его в Postman, Insomnia или code generator.
3. Подставьте External API key в заголовок Authorization.

Следующие материалы

Связанные страницы

Справочник API

Готово

Справочник по endpoint-ам Treker Zadachek External API, filters, pagination и типовым шаблонам запросов.

Безопасность и модель доступа

Готово

Модель безопасности Treker Zadachek MCP и External API: project scope, работа с API key, token redaction и безопасное поведение оператора.

Коротко

О чём эта страница

External API Treker Zadachek

External API Treker Zadachek — scoped HTTP-поверхность для projects, tasks, comments, analytics и verification reads. Нужна интеграциям с прямым контрактом вместо MCP runtime.

FAQ

External API публичен и работает без аутентификации?

Нет. Публична документация, но сам API требует external API key и enforce-ит project scope через режимы selected_projects или all_projects.

Можно ли использовать API как source of truth после записи через MCP?

Да. Это рекомендуемая verification-модель, когда нужно независимое HTTP-подтверждение того, что workflow-мутация действительно изменила backend state.

Источники

Обзор External API

docs/api/external-statistics-api-overview.md

Высокоуровневая рамка API и модель аутентификации.

Reference External API

docs/api/external-statistics-api.md

Семейства HTTP endpoint-ов, filters, shape ответа и примеры.

Контракт OpenAPI

docs/openapi/external-statistics-v1.yaml

Machine-readable reference для tooling и генерации клиентов.

Справочник API

Безопасность и модель доступа