Вопросы заказчика: разработка API
Как оценить работу, если методы ещё не определены?
Отдельным этапом. Сначала оплачивается проектирование контракта: интервью с потребителями, описание сущностей и полей, перечень методов и сценариев обмена. По его итогам появляется список эндпоинтов, каждый из которых оценивается в часах. Оценка «всего API целиком» до этого этапа не имеет под собой оснований и обычно оказывается заниженной.
Кто пишет документацию и нужна ли она, если интегратор один?
Документацию готовит команда разработки, и она нужна даже при одном потребителе. Без неё каждый вопрос интегратора решается перепиской с разработчиком, а при смене людей на любой стороне знание теряется. В смете это отдельная позиция: описание методов, параметров, кодов ошибок и примеров запросов с ответами.
Что делать, когда потребуется изменить формат данных?
Для этого и вводится версионирование. Совместимые изменения — добавление новых необязательных полей — выпускаются в текущей версии. Несовместимые вынесите в новую версию и укажите в предложении, сколько времени поддерживается предыдущая, чтобы у подключённых сторон был срок на переход. Работы по переводу потребителей оцениваются отдельно.
Нужны ли ограничения на число запросов?
Да, если API доступно снаружи. Ошибка в коде потребителя способна создать нагрузку, от которой пострадает основная система, а без лимита и журнала невозможно понять, чей именно ключ её создал. Ограничение частоты и понятный ответ при его превышении — стандартная часть работ, которую стоит показать в смете строкой.
Отвечаете ли вы за интеграцию на стороне партнёра?
Нет. Ваша зона — методы, соответствующие согласованному контракту, тестовая среда и документация. Работа разработчиков партнёра, их сроки и ошибки в формировании запросов остаются на их стороне. Консультации по подключению можно оказывать, но их лучше вынести в отдельную позицию с оплатой по часам или пакетом часов на интеграцию.
Блоки, смета с расчётом и условия уже готовы — останется вписать свои цены. Клиент открывает ссылку в браузере, а вы видите, кто её открыл и докуда дочитал.