Документация для площадок
Перевал соединяет приложения и сайты знакомств в одну сеть. Ваш пользователь остаётся у вас, но видит людей из других приложений, ставит им лайки и переписывается — с переводом, если языки разные. Базовое подключение и обмен анкетами, обычными лайками, мэтчами и сообщениями бесплатны. Дополнительные услуги необязательны.
Мы только запускаем сеть: внешних анкет может быть мало или не быть совсем. Если вы подключитесь первыми, знакомства с пользователями других площадок станут возможны после их присоединения. Пока можно проверить интеграцию в песочнице и подготовиться к росту сети. Для ранних участников готовим бонусы на дополнительные услуги; размеры и условия опубликуем отдельно. Площадкам-основателям.
С чего начать
Сначала выберите старт по продукту. Он самодостаточный: что хранить, какие запросы, когда интеграция готова. Полные правила и все поля — в разделах ниже и в справочнике API.
| Ваш продукт | Старт |
|---|---|
| приложение, где человек листает анкеты по одной | Приложение-листалка |
| сайт с фильтрами и страницами анкет | Сайт с поиском |
| бот, и адреса для вебхуков нет | Бот |
| хотите проверить API и песочницу через curl | Проверить API в песочнице |
| ещё не решили, каким способом подключаться | Варианты подключения |
| интеграцию пишет ИИ-агент | Для ИИ-агентов — агенту достаточно этой страницы и старта под продукт |
Путь от заявки до запуска
- Подайте заявку. Мы вручную проверим площадку и откроем кабинет.
- Проверьте API в тестовом контуре. Выпустите тестовый ключ, отправьте
pingи пройдите сценарий с песочницей. Проверка API в песочнице подтверждает, что запросы и события работают; это ещё не готовая интеграция в ваш продукт. - Встройте сценарий в свой продукт. Добавьте добровольное согласие, синхронизацию анкет, показ сетевой ленты и обработку лайков, мэтчей, сообщений и событий. Выберите старт для приложения, сайта или бота.
- Пройдите чек-лист и включите боевой контур. Убедитесь, что согласия, удаление, подписи событий и пользовательские предупреждения работают, затем выпустите боевой ключ в кабинете. Полный список — в разделе тестирование.
Что нужно встроить в свой продукт
- Согласие пользователя. Переключатель «Показывать меня в сети Перевал» в настройках анкеты, выключенный по умолчанию (и, по желанию, «Готов общаться на других языках»). Без включённого согласия анкета в сеть не уходит.
- Отправка анкет. Когда человек включил участие или изменил анкету —
PUT /v1/members/{ваш_id_пользователя}. Первую загрузку удобно делать пачками —PUT /v1/members. - Лента. Показывайте людей из сети рядом со своими:
GET /v1/members/{id}/feed. На карточке — пометка, из какого приложения человек. В листалке пропуск без лайка — дизлайк. На сайте с поиском страницы идут курсором, дизлайк — только явный отказ. - Лайки, мэтчи, сообщения — несколько запросов и приём событий: вебхуками или запросом
GET /v1/events.
Объём работ зависит от устройства вашего продукта. Минимальный пользовательский сценарий включает анкеты и согласия, ленту, лайки и пропуски, переписку и обработку событий.
Принципы сети
- Пользователь — ваш. Сеть не общается с вашими пользователями напрямую, не собирает их контакты и не переманивает. Весь интерфейс — ваш.
- Только по согласию. В сети только те, кто сам включил участие. Общение на других языках — отдельное согласие.
- Удаление сразу. Один запрос стирает анкету человека из сети; у собеседников остаётся история переписки без имени и фото.
- Можно приостановить подключение. Приостановка скрывает анкеты площадки из выдачи и запрещает новые лайки и сообщения в обе стороны. История не удаляется, доставка событий приостанавливается. Это не удаление данных пользователей; для удаления анкеты используется отдельный запрос.
- Базовое подключение бесплатно. Буст, суперлайк, инкогнито и отмена решений — необязательные услуги сети, на старте по 0 ₽. Площадка сама определяет свои предложения пользователям. Правила против фейков и сбора базы действуют для всех; тариф за обычный рост площадки не установлен.
- Открытый протокол. Описание публичное, изменения — с версией и заранее, несовместимые — за 60 дней.
Версия протокола
Эта документация закрепляет спецификацию 1.0.0 из согласованного релиза сети. Это не подтверждает, что такая версия уже развёрнута на публичном API: до включения возможностей проверьте GET /v1/capabilities с ключом нужного контура. Ответ 404 означает, что этот runtime-контракт ещё не поддерживается, а не что все функции доступны.
В протоколе есть анкеты и согласия, лента рядом и «Весь мир», лайки, суперлайки, дизлайки, мэтчи и события вебхуками или запросом. Перевод зависит от настроенного сервиса; при сбое остаётся оригинал. Видео в production выключено до появления покадровой модерации: при videos: false не отправляйте непустое videos. Наличие конфигурации в capabilities не доказывает исправность внешних сервисов; /readyz проверяет только доступность базы. Звонков пока нет. Полный список — в журнале.