Что потребуется
Для старта вам понадобятся:
- аккаунт администратора в bartys;
- доступ к dev-окружению;
- домен или тестовый поддомен для публикации;
- понимание структуры проекта и сценария интеграции.
Что упростит разработку
Подготовьте отдельный dev-стенд, чтобы не смешивать черновую разработку с продакшеном.
- используйте отдельную базу данных;
- держите конфиги доменов и ключей в
.env; - заведите тестового администратора заранее.
Перед подключением
Перед созданием первого приложения проверьте:
- что домен уже указывает на нужный сервер;
- что админка доступна по
/admin/login; - что приложение открывается локально без ошибок маршрутизации;
- что все чувствительные тестовые роуты уже отключены.
Как добавить приложение в bartys
Создайте новый раздел документации в админке и добавьте первую страницу с описанием сценария интеграции. Для каждой новой интеграции лучше использовать отдельный раздел.
Создание структуры
Обычно структура состоит из:
- обзорной страницы;
- страницы по авторизации;
- страницы по событиям и webhook;
- страницы по деплою.
Что публиковать первым
Первыми публикуйте только обязательные шаги, без лишних внутренних деталей. Это уменьшает шум и ускоряет подключение команды.
Как работать с диплинками
Если продукт использует диплинки, описывайте их в отдельном блоке на странице с примерами параметров и ожидаемого поведения.
Создание диплинка приложения
Формируйте диплинк в виде предсказуемого URL и документируйте обязательные query-параметры.
Payload в приложении
Если вы передаёте состояние или идентификатор сценария, зафиксируйте структуру payload в явном виде и не меняйте её без версии.
Диплинк для шеринга контента
Для ссылок на расшаривание контента укажите, какие поля обязательны, какие опциональны, и как система ведёт себя при частичном payload.
Как управлять приложением
После публикации документации назначьте ответственного за актуальность раздела и обновляйте инструкции при каждом изменении продукта.
Обновление ссылки на приложение
Меняйте публичную ссылку только после проверки редиректов, SSL и доступности на чистом окружении.
Изменение кнопки открытия приложения
Если меняется текст или логика CTA-кнопки, это должно быть отражено и в продукте, и в документации в один релиз.
Удаление приложения
Перед удалением приложения снимите все публичные ссылки и оставьте короткое уведомление для команд, которые могли использовать старый URL.
Как открыть приложение по прямой ссылке
Опишите рабочий путь открытия приложения по прямой ссылке, ограничения по окружениям и ожидаемое поведение для незалогиненного пользователя.