Если на вашем веб-сайте есть членство, программы или продукты, вы можете решить, к каким группам пользователей форума принадлежит каждый участник. Ваш веб-сайт устанавливает правила и передает идентификаторы групп форуму, поэтому количество посещений форума всегда совпадает с количеством участников на вашем сайте.
Как это работает
- Какие группы назначать. Ваш веб-сайт подбирает нужные группы для каждого участника и передает их на форум.
- Стоит ли начинать однократный вход. Если срок действия продуктов или программ участника истек, ваш веб-сайт просто не регистрирует их на форуме.
Сам форум никогда не читает ваши записи о членстве. Все зависит от вашего веб-сайта.
Прежде чем начать
- Получите свой ключ API. Он нужен вам для каждого запроса в этой статье.
- Получите идентификатор каждой группы пользователей, которую вы хотите назначить, например, по одной группе на программу.
Назначьте группы при создании учетной записи
Включите параметр UserGroups в запрос на единый вход в систему. Если учетная запись еще не существует, она создается вместе с этими группами.
Разделите несколько идентификаторов запятыми. Эти группы применяются при первом создании учетной записи. Чтобы изменить группы позже, используйте запросы API в следующем разделе.
Обновляйте группы при изменении состава
Если участник покупает, обновляет или теряет программу на вашем веб-сайте, обновите свои группы на форуме с помощью API Website Toolbox. Эти запросы отправляются с вашего сервера, поэтому вы можете отправить их в момент внесения изменений. Участнику не нужно входить в систему.
Обновите все группы участника одним запросом
Чтобы внести сразу несколько изменений, например добавить участника в две группы и удалить его из одной, отправьте по одному запросу на конечную точку участника, к каждой группе, к которой он должен принадлежать. Отправляемые вами группы заменяют текущие группы участника, поэтому включите все группы, которые вы хотите сохранить в них.
Чтобы увидеть текущие группы участников перед их заменой, отправьте GET-запрос на тот же адрес.
Ответ включает текущие группы пользователей участника.
Добавить или удалить одну группу
Если вам нужно предоставить или отозвать только одну группу, вместо этого используйте конечную точку группы, чтобы не отправлять полный список.
USER_ID — это идентификатор пользователя форума, который возвращается запросом на вход в систему при создании учетной записи. Вместо идентификаторов пользователей можно передавать имена пользователей или адреса электронной почты. Вместо этого на адрес электронной почты пользователя, у которого нет учетной записи на форуме, будет отправлено приглашение в группу.
Решение о том, кому будет предоставлен доступ
Ваш веб-сайт проверяет членство участника перед тем, как начать однократный вход. Если у пользователя все еще есть доступ, войдите в систему с помощью токена, как описано в разделе Единый вход — аутентификация на основе токенов. Если срок действия их продуктов истек, не начинайте процедуру единого входа, и они не войдут на форум.
Часто задаваемые вопросы
Должен ли я обновлять группы участников или использовать конечную точку группы?
Если вы меняете несколько групп одновременно, отправьте полный список групп на конечную точку участника. Используйте конечную точку группы, когда добавляете или удаляете только одну группу.
Когда следует обновлять группы пользователей участника?
Обновляйте группы при каждом изменении состава участников на вашем веб-сайте, например при покупке, обновлении или истечении срока действия. Нет необходимости ждать следующего входа участника в систему.
Нужно ли входить в систему участника для обновления групп?
Нет. Обновление представляет собой запрос API с вашего сервера, поэтому оно работает независимо от того, вошел ли пользователь в систему или посетил форум.
Что такое curl?
Curl — это инструмент командной строки для отправки HTTP-запросов, который входит в состав macOS, Linux и последних версий Windows, поэтому примеры в этой статье написаны в виде команд curl. Вы можете отправлять одинаковые запросы с любого языка программирования, используя стандартные инструменты HTTP с одинаковыми параметрами на всех языках. Примеры на нескольких языках см. в разделе Пример кода HTTP-запроса.
Почему запрос API не выполняется?
Убедитесь, что ключ API соответствует ключу API вашего форума, что идентификатор группы и идентификатор пользователя верны, а также что у участника уже есть учетная запись на форуме.
Как найти идентификатор группы пользователей?
См. раздел Получение идентификатора группы пользователей.