Как участнику получить свой API-ключ

Свой API-ключ позволяет участнику работать с выданными ему папками через программу. Например, преподаватель может открыть студенту только папку «ТЕСТ»: личный ключ студента будет действовать в этом пространстве и учитывать его права.

Это отдельный ключ участника. Ключи владельца находятся в «API / MCP»; передавать их коллеге для этой задачи не нужно.

1. Владелец разрешает API-доступ

1. Владелец или администратор с правом управления участниками открывает «Участники» → ⋮ возле участника → «Редактировать».
2. Проверяет роль и поле «Папки». Для нашего примера оставляет только «ТЕСТ».
3. Включает «Доступ к API», при необходимости задаёт дату окончания и нажимает «Сохранить». Без даты разрешение действует до отзыва.

Увеличить

При приглашении нового участника учитывается лимит участников пространства. Подробности приглашения и ролей — в инструкции о совместной работе. Включение переключателя ещё не создаёт ключ.

2. Участник создаёт свой ключ

1. Примите приглашение и войдите под той почтой, на которую оно пришло. Выберите пространство преподавателя или команды.
2. Нажмите значок профиля → «Мой API-доступ». Проверьте название пространства и срок разрешения.
3. Откройте создание ключа, задайте понятное имя, например «Учебный проект», и подтвердите создание.
4. Скопируйте полный ключ сразу. Он показывается один раз. После закрытия окна в списке остаётся только его окончание.

Увеличить

У каждого участника может быть один действующий ключ в одном пространстве. В списке видны имя, окончание ключа, дата создания, срок и последняя активность. Сам владелец секрет участника не видит.

3. Проверьте доступ к папкам

Начните с чтения списка папок. В Postman или своей программе отправьте запрос:

• Метод: GET.
• Адрес: https://api.webask.io/api/v3/service/folders.
• Заголовок: Authorization: Bearer YOUR_MEMBER_API_KEY — замените заглушку своим ключом.

В учебном примере в списке должна быть доступная папка «ТЕСТ», без папок, которые владельцем не выданы. Для работы с опросами используются методы API v3: чтение, создание, сохранение, публикация и чтение ответов. Каждое действие дополнительно проверяет роль: ключ сам по себе не открывает результаты и редактирование. Подробности — в документации по авторизации.

Если владелец изменит роль или доступные папки, следующие запросы начнут учитывать новые права. Через кабинет ключ получает доступ ко всем выданным папкам, в том числе добавленным позже. Более узкие ограничения действий, папок и срока можно задать при создании через API; в форме кабинета отдельных полей для них нет.

4. Перевыпустите или отзовите ключ

В «Мой API-доступ» откройте меню ⋮ возле действующего ключа. Перевыпуск заменяет старый ключ новым: обновите его в своей программе. Отзыв прекращает работу старого ключа, а разрешение создать другой остаётся. Если срок ключа уже закончился, создайте новый.

Владелец может отдельно отозвать ключ в карточке участника или выключить «Доступ к API». Выключение доступа и удаление участника отзывают его ключи. Ключ не действует дольше срока, который разрешил владелец.

Храните ключ в защищённых настройках программы или переменной окружения. Не вставляйте его в адрес ссылки, код страницы, переписку или снимки экрана. Если полный ключ потерян или попал постороннему, перевыпустите его.

Если раздел или ключ недоступен

• Нет «Мой API-доступ»: проверьте выбранное пространство. В своём пространстве вы владелец и используете «API / MCP».
• Нет разрешения или закончился срок: попросите владельца проверить «Доступ к API» и дату в вашей карточке.
• Нет нужного опроса или ответов: владелец проверяет папки и роль. Разрешение на ключ не заменяет эти права.