VK People Hub PublicAPI¶
Важно!
Текущая реализация PublicAPI представлена в виде alpha-версии и предназначена исключительно для ознакомительных целей и прототипирования на локальных/тестовых стендах.
Использование alpha-версии PublicAPI на продуктивных стендах - запрещено!
В ближайших квартальных релизах (Q2-Q3) PublicAPI будет расширено/скорректировано (API сервиса уведомлений, требования к клиентской аутентификации, ...).
Целевая стабильная версия поставки PublicAPI может иметь значительные отличия от alpha-версии.
Для своего функционирования alpha-версия PublicAPI требует включения соответствующего feature-флага в переменных окружения (см. инструкцию по установке). По умолчанию alpha-версия PublicAPI выключена.
Возможности VK People Hub PublicAPI¶
VK PeopleHub PublicAPI - средство для решения задач сервисной интеграции и интеграции с внешними ИС.
Авторизуемый субъект доступа (конечный клиент PublicAPI) - сервис, но не пользователь.
Таким образом:
- PublicAPI обеспечивает генерализованный доступ к работе с данными безотносительно к субъекту-владельцу (конкретному пользователю, роли, т.п.).
- Ответственность за порчу данных в системе лежит на субъекте доступа к PublicAPI (сервис-клиент).
- Рекомендуется регулярное резервное копирование данных.
- Необходима выдача гранулярных прав доступа конкретного сервиса к конкретному API.
- Не подходит для осуществления прямого доступа с front-end, но только для вендорских сервисов на стороне back-end.
- В случае возникновения потребности управления пользовательскими данными с front-end, предлагается использование WidgetSDK на стороне front-end, а также написание собственного сервиса back-end, взаимодействующего с PublicAPI.
- Не рекомендуется расположение бизнес-логики Вашего сервиса на стороне front-end.
Именование HTTP REST URL для VK People Hub PublicAPI¶
HTTP REST URL для PublicAPI включает следующие обязательные компоненты:
- параметр, определяющий публичность API:
- public
- параметр, определяющий идентификатор версии конкретного API:
- v_alpha
- параметры для определения назначения API.
Гарантии обратной совместимости¶
- Поддержка устаревшей версии API в течение 2-х квартальных релизов (за исключением alpha-версии PublicAPI, поддержка которой будет прекращена сразу после выхода стабильной версии PublicAPI).
- Презентация новых версий PublicAPI на ежеквартальных демо продукта VK People Hub.
- Внесение в документацию сроков вывода устаревших версий API.