ТЗ на интеграцию по API
Вы получаете черновик задания для подрядчика: что и когда передаётся между системами, что делать при сбоях и как принять работу. Меньше переделок и споров о том, «что имелось в виду».
Зачем
Интеграции часто заказывают «на словах»: не описано, какие данные передаются, что делать при ошибке и как проверить результат. Подрядчик понимает по-своему, появляются дубли и сбои, сроки и бюджет растут.
Кому?
Владелец или менеджер, когда нужно заказать интеграцию сайта или склада с другой системой, а ТЗ писать некому.
Подойдёт, если нужно
- Заявки с сайта должны попадать в CRM сделками, по одной на заявку
- Остатки и цены со склада нужно передавать на маркетплейс раз в час
- Перед разговором с подрядчиком нужен список вопросов и что согласовать
- Нужно понять, по чему принимать работу у интегратора
Не подойдёт, если нужно
Когда не подойдёт ↓
- Написание кода и настройка сервера: это делает разработчик
- Точные адреса и поля чужого сервиса: их берут из его документации
- Передача паролей и ключей: в задании описывают только требования к доступам
- Написание кода и настройка сервера: это делает разработчик
- Точные адреса и поля чужого сервиса: их берут из его документации
- Передача паролей и ключей: в задании описывают только требования к доступам
Как пользоваться
- 1
Опишите задачу. Хотим, чтобы заявки с сайта сами попадали в нашу CRM: одна заявка — одна сделка. С формы приходят номер заявки, имя и телефон, доступ к CRM по токену, документация у нас есть. Составь черновик ТЗ для подрядчика.
- 2
Получите черновик. Склад должен раз в час отдавать на маркетплейс остатки и цены, товары различаются кодом sku. Названий систем пока нет. Что записать в ТЗ и что спросить у подрядчика до начала работы?
- 3
Проверьте результат. Напиши код интеграции сайта с CRM и настрой её на нашем сервере.
Ограничения и данные
Skill проверен модератором перед публикацией в каталоге.
- Работает только с текстом, который вы вставили.
- Не подключается к CRM, мессенджерам, 1С, API или файлам в демо.
- Не вводите пароли, API-ключи и реальные персональные или платёжные данные.
- Переписку и файлы мы не сохраняем в базе данных — они существуют только в открытом окне демо.
- Текст запроса и вложений временно передаётся LLM-провайдеру для генерации ответа.
- Проверяйте результат перед использованием в рабочем процессе.
Для технарей: SKILL.md и экспорт
Установка и экспорт
Скачайте SKILL.md, metadata.json, правило Cursor или адаптер под вашу платформу. Файлы генерируются из текущей версии skill и кешируются в хранилище.
Адаптеры платформ
Частые вопросы
Помощник напишет код интеграции?
Нет. Он готовит задание: цель, что передаётся, как обрабатывать сбои, по чему принимать работу. Код и настройку делает разработчик по этому заданию.
Что важно записать до начала работы?
Что и в какую сторону передаём, как часто, какие данные, как защищены доступы, что делать при ошибке и как не создать дубль, и по чему вы примете результат.
Можно ли вставлять в ТЗ ключи и пароли?
Нет. В задании описывают только требования к доступам. Ключи передают подрядчику отдельно и безопасно.
Помощник знает API нужного сервиса?
Нет. Он опирается на ваши слова. Точные адреса, поля и лимиты берут из документации сервиса, и такие места в ответе помечены «уточнить».
Платформы
История
1.1.4 — F-pass: seoTitle/seoDescription для карточки.
Частые вопросы
Помощник напишет код интеграции?
Нет. Он готовит задание: цель, что передаётся, как обрабатывать сбои, по чему принимать работу. Код и настройку делает разработчик по этому заданию.
Что важно записать до начала работы?
Что и в какую сторону передаём, как часто, какие данные, как защищены доступы, что делать при ошибке и как не создать дубль, и по чему вы примете результат.
Можно ли вставлять в ТЗ ключи и пароли?
Нет. В задании описывают только требования к доступам. Ключи передают подрядчику отдельно и безопасно.
Помощник знает API нужного сервиса?
Нет. Он опирается на ваши слова. Точные адреса, поля и лимиты берут из документации сервиса, и такие места в ответе помечены «уточнить».
Похожие навыки
Нужно под ваш процесс?
Подстроим навык под ваши офферы, тон и ограничения. Или добавим новый, если такого нет.
Адаптировать под мой бизнес