Портал документации API
Описываем до 25 предоставленных методов API. Добавляем параметры, ответы и согласованные примеры. Настраиваем поиск по документации. Добавляем changelog и проверяем ссылки. Проводим контрольную проверку: каждый опубликованный метод открывается из навигации и находится поиском.
Когда стоит обратиться
Обычно к нам обращаются в таких ситуациях:
- Описание API разбросано по документам и расходится с актуальными параметрами.
- Разработчику трудно найти метод или готовый пример запроса.
- Текущий процесс ведётся в таблицах, чатах или вручную, и его хочется собрать в одном понятном веб-инструменте.
Что именно мы сделаем
Описываем до 25 предоставленных методов API.
Добавляем параметры, ответы и согласованные примеры.
Настраиваем поиск по документации.
Добавляем changelog и проверяем ссылки.
Проводим контрольную проверку: каждый опубликованный метод открывается из навигации и находится поиском.
Что входит в стоимость
30 000 ₽ за всю работу
Описываем до 25 предоставленных методов API. Добавляем параметры, ответы и согласованные примеры. Настраиваем поиск по документации. Перед сдачей проверяем, что каждый опубликованный метод открывается из навигации и находится поиском. В комплект результата входят: портал документации до 25 методов; параметры и примеры запросов; поиск и changelog. Небольшие связанные уточнения, которые появляются во время работы, уже учитываем в стоимости.
Что будет готово
Передадим вам
- Портал документации до 25 методов.
- Параметры и примеры запросов.
- Поиск и changelog.
Перед сдачей проверим
- Каждый опубликованный метод открывается из навигации и находится поиском.
- Параметры и примеры совпадают с предоставленной контрольной спецификацией.
- Тестовая запись changelog содержит дату и ссылку на нужный раздел.
Как это выглядит на практике
документация двух методов
Типичная ситуация: описание API разбросано по документам и расходится с актуальными параметрами. Сначала добавляем два тестовых метода, затем указываем параметры и пример, а в финале находим метод через поиск.
- 01
Добавляем два тестовых метода.
- 02
Указываем параметры и пример.
- 03
Находим метод через поиск.
- 04
Публикуем запись changelog.
Что понадобится для работы
От вас
- Действующие спецификации, примеры запросов и ответов и список сценариев, которые разработчики ищут чаще всего.
- Правила авторизации и версионирования, материалы бренда и контакт команды, которая поддерживает интерфейс.
- Один знакомый сотрудникам случай, по которому можно подтвердить, что каждый опубликованный метод открывается из навигации и находится поиском.
Если у вас немного другая ситуация
Небольшие уточнения, которые помогают довести согласованный результат до рабочего состояния, уже учитываем в цене. Если по ходу работы появится отдельный крупный блок или понадобится платная лицензия, сначала обсудим варианты и стоимость. Расскажите о своей ситуации — подстроим план под неё.
- 3 000 ₽после подписания договора через Диадок
- 27 000 ₽после выполнения, демонстрации и приёмки результата
Предоплата входит в общую стоимость. Оставшуюся сумму оплачиваете после демонстрации и приёмки готовой работы.
Часто спрашивают
Об этой услуге
Как лучше решить задачу, если описание API разбросано по документам и расходится с актуальными параметрами?
Первым делом описываем до 25 предоставленных методов API. После этого добавляем параметры, ответы и согласованные примеры.
Что настроим в рамках услуги «Портал документации API»?
Сначала настраиваем поиск по документации. Затем добавляем changelog и проверяем ссылки. При итоговой проверке используем понятный признак: параметры и примеры совпадают с предоставленной контрольной спецификацией.
Какие части решения «Портал документации API» будут готовы?
В состав результата входят: портал документации до 25 методов; параметры и примеры запросов; поиск и changelog.
Какие сценарии проверим для «Портал документации API»?
Для приёмки фиксируем: каждый опубликованный метод открывается из навигации и находится поиском; параметры и примеры совпадают с предоставленной контрольной спецификацией; тестовая запись changelog содержит дату и ссылку на нужный раздел.
Цена и изменения по ходу работы
Цена на странице окончательная?
Да. Перед началом мы сверяем исходные данные и фиксируем результат в договоре. Указанная на странице сумма покрывает согласованную работу целиком, даже если её техническая реализация потребует больше времени, чем ожидалось при оценке.
Что означает резерв незапланированных работ?
Это уже включённый в цену запас времени на небольшие связанные уточнения заказчика, которые появляются после старта: например, добавить поле, изменить формат уведомления или учесть ещё одно условие обработки.
Резерв рассчитывается по формуле: стоимость услуги × 30% ÷ 1 500 ₽. Для услуги за 30 000 ₽ это 6 часов. Эти часы относятся только к дополнительным, заранее незапланированным уточнениям. Они не являются сроком проекта и не ограничивают время на основную работу: согласованный результат мы выполняем полностью.
Можно уточнять детали уже во время работы?
Да. Небольшие связанные изменения обычно помещаются во включённый резерв и не требуют доплаты. Если новая идея заметно меняет результат или превращается в самостоятельную задачу, сначала обсудим подход и стоимость. Любое решение согласуем до выполнения.
Начало работы и оплата
Как оформляются договор и оплата?
Подписываем договор через Диадок. Предоплата составляет 3 000 ₽ и входит в общую стоимость услуги. Остаток оплачивается после демонстрации и приёмки готового результата.
Когда начинается срок выполнения?
Срок отсчитывается после согласования задачи, получения необходимых доступов и материалов, подписания договора и поступления предоплаты. Конкретную дату старта и плановый день готовности подтверждаем перед началом.
Как учитываются платные лицензии и внешние сервисы?
До старта проверяем, нужны ли тарифы, лицензии, сертификаты или дополнительные ресурсы внешних систем. Если они потребуются, заранее покажем варианты и стоимость. По возможности аккаунты и лицензии оформляются сразу на заказчика.
Проверка результата и гарантия
Как принимается готовая работа?
Вместе проверяем согласованные сценарии на контрольных данных или тестовой копии, а затем демонстрируем результат. Для интеграций сверяем передачу данных и обработку ошибок, для сайта — работу нужных страниц и действий пользователя, для отчёта — расчёты и обновление данных.
Какая гарантия действует после сдачи?
На выполненные изменения действует гарантия 3 месяца. Если в изменённой нами части обнаружится ошибка нашей реализации, проверим и исправим её без дополнительной оплаты. Переданные материалы, настройки и код остаются у заказчика.