Когда вы просите своих пользователей создать или подключить свои ORCID iD в свою систему, вы можете сэкономить время и силы своих исследователей, введя информацию, которую ваша система уже хранит о них, установив их язык отображения и выписав их из любых активных сеансов, чтобы убедиться, что они вошли в правильный ORCID счет.
Команда ORCID API-интерфейсы предлагают несколько вариантов настройки взаимодействия с пользователем.
Предварительно заполните форму регистрации / входа
ORCID предоставляет членам возможность предварительного заполнения формы регистрации/входа OAuth в рамках взаимодействия API с использованием параметров на URL-адресе https://orcid.org/oauth/authorize
Могут использоваться любые или все параметры:
Параметр | Поиск | Заметки |
второе имя | Собственное имя | Команда имя поле будет заполнено на регистрационный формуляр если указанный адрес электронной почты или ORCID iD не соответствует активному ORCID записи. |
фамильные имена | Фамилия | Команда Фамилия поле будет заполнено на регистрационный формуляр если указанный адрес электронной почты или ORCID iD не соответствует активному ORCID записи. |
Эл. адрес | Команда электронное письмо/ORCID iD поле будет заполнено на форма входа если указанный адрес электронной почты найден в нашей системе и недействителен ORCID iD указан. e-mail поле будет заполнено на регистрационный формуляр если указанный адрес электронной почты найден в нашей системе и недействителен ORCID iD указан. адрес электронной почты должен быть URL закодирован, включая изменение «@» на «% 40». Если вы знаете пользователя ORCID iD и адрес электронной почты, мы предлагаем Важно предоставляя ORCID iD в параметре orcid. | |
орхидея | ORCID iD | Команда электронное письмо/ORCID iD поле будет заполнено на форма входа если указанный ORCID iD находится в нашей системе. регистрационный формуляр в противном случае будет отображаться, если указанный ORCID iD не встречается в нашей системе. ORCID iD должен быть в 16-значный формат iD URI. |
Пример URL с этими параметрами:
https://sandbox.orcid.org/oauth/authorize?client_id=APP-NPXKK6HFN6TJ4YYIn&response_type=coden&scope=/authenticaten&redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplaygroundn&family_names=Finn&given_names=Huckleberry&email=huckle%40mailinator.com
Установите язык отображения
ORCID предлагает возможность указать язык отображения формы регистрации/входа OAuth как часть взаимодействия API с помощью параметра «lang» в URL-адресе https://orcid.org/oauth/authorize. Это также установит предпочтения пользователя относительно языка отображения.
Пользователи могут в любой момент самостоятельно изменить язык отображения. Доступны следующие языковые настройки:
Язык | Code |
عربى (арабский) | ar |
Чештина (чешский) | cs |
Английский | en |
Español (Spanish) | es |
Français (French) | fr |
Deutsch (Немецкий) | de |
Italiano (итальянский) | it |
日本語 (японский) | ja |
한국어 (корейский) | ko |
Polski (польский) | pl |
Português (португальский) | pt |
Русский (Русский) | ru |
Türkçe (турецкий) | tr |
简体 中文 (упрощенный китайский) | zh_CN |
繁體 中文 (традиционный китайский) | zh_TW |
Пример
В этом примере форма предварительно заполняется, а язык - испанский.
https://sandbox.orcid.org/oauth/authorize?client_id=APP-NPXKK6HFN6TJ4YYI
&response_type=code
&scope=/authenticate
&redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplayground
&family_names=Finn&given_names=Huckleberry&email=huck%40mailinator.com
&lang=es
По умолчанию используется форма входа или форма регистрации.
В настоящее время ORCID Экран OAuth по умолчанию представляет форму входа и предоставляет ссылку для перехода к форме регистрации. Независимо от поведения по умолчанию, отображаемую форму можно настроить, добавив параметр «& show_login = true» для отображения формы входа или «& show_login = false» для отображения формы регистрации. Обратите внимание, что если адрес электронной почты или ORCID iD указаны в URL-адресе, показанная форма будет определяться этими параметрами, а параметр & show_login будет проигнорирован.
ORCID настоятельно рекомендует разрешить конечным пользователям изменять размер окна входа OAuth для улучшения доступности в соответствии с нашими ценностями, касающимися включения.
Идентифицируйте исследователя по настраиваемому параметру "состояние"
Это используется некоторыми интеграциями по техническим причинам. Он не отображается на экране входа.
Параметр состояния может быть включен в URL-адрес авторизации для идентификации пользователя, например, уникальная последовательность чисел, которая преобразуется во внутренний идентификатор пользователя в вашей системе. Параметр не влияет на взаимодействие с пользователем, но он будет возвращен с кодом авторизации и может использоваться для идентификации пользователя или сеанса. Параметр состояния также возвращается, если пользователь запрещает доступ.
Обратите внимание, что параметр состояния имеет ограничение в 2000 символов.
При желании принудительный выход
Вы можете выйти из системы, если подозреваете, что на одной машине работает несколько пользователей.
Если вас беспокоит, что несколько пользователей находятся на одном компьютере и не выходят из системы между сеансами, вы можете заставить их повторно пройти аутентификацию во время процесса OAuth. Просто включите prompt=login
в запросе OAuth. Вы также можете установить max_age в секундах, чтобы заставить пользователей повторно аутентифицироваться, если их сеанс превышает определенную длину. Смотрите наши Документация OpenID Connect Больше подробностей.
Пропуск авторизации
ORCID пропускает авторизацию при определенных обстоятельствах.
Если активный токен доступа уже существует с теми же областями, которые запрашивает ваш URL-адрес авторизации OAuth, и пользователь вошел в свою ORCID записи, им не будет предложено повторно предоставить авторизацию. Вместо этого они будут перенаправлены непосредственно на URI перенаправления. Если вы хотите требовать от пользователя предоставления авторизации при каждом подключении, используйте метод принудительного выхода