Миграция с v2 на v3

Узнайте, как безопасно перейти с API v2 на v3

Миграция с v2 на v3

WebAsk API v3 является текущей основной версией. Этот раздел помогает разработчикам, которые уже используют API v2, безопасно перейти на v3 и понять, какие изменения были внесены.

Полная таблица изменений и все примеры находятся в разделе ## Миграция с v2 на v3 файла api_v3.md.

Ключевые изменения

  • Новый базовый URL:
    /api/v2/service → /api/v3/service
  • GET /quiz (список опросов): в v3 добавлены папки и дополнительные поля в ответе.
  • Пагинация: переход на стандартные параметры page / per_page для части эндпоинтов.
  • Новые эндпоинты аутентификации: /register, /login, /user.
  • Новые эндпоинты экспорта и отчётов: экспорт ответов и отчётов в CSV/XLSX/PDF/Word, дополнительные данные отчётов и публичные ссылки.

Практические шаги по миграции

  1. Обновите базовый URL с /api/v2/service на /api/v3/service.
  2. Проверьте используемые вами эндпоинты в v2 и найдите их аналоги в документации v3 (в первую очередь: опросы, ответы, отчёты).
  3. Если вы работали с пагинацией, перейдите на параметры page / per_page, где это требуется.
  4. При необходимости начните использовать новые возможности: промокоды, экспорт, дополнительные данные отчётов, интеграции.
  5. Сохраните ссылку на архивную документацию v2, если вам нужно время на поэтапный переход.

В файле API_V2_ARCHIVE.md приведена краткая сводка по API v2, а в api_v3.md — полный список эндпоинтов v3 и сопоставление ключевых сценариев.