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