Шаг 2 (из 5)
2. Соберите проверенные ORCID идентификаторы и разрешения
На этом шаге узнайте, как получить аутентифицированный iD и разрешение, необходимое для чтения и записи данных в и из ORCID записи.
ORCID интеграции используют “Трехсторонний OAuth», чтобы аутентифицировать пользователей и запрашивать разрешение на взаимодействие с их записями. ORCID участники могут использовать Member API для запроса разрешений на чтение и запись.
В этом разделе мы рассмотрим шаги, которые необходимо выполнить для вашей пользовательской интеграции, чтобы получить аутентифицированный iD и разрешение на чтение и запись в ORCID запись
Получение аутентификации iD и разрешение на доступ к записи от пользователя включает в себя следующие ОАут 2.0, стандартный отраслевой протокол для авторизации. OAuth позволяет пользователю предоставить веб-сайту или приложению доступ к информации учетной записи, хранящейся на другом сайте, не сообщая этому сайту свой пароль.
Если вы когда-либо входили на сайт, используя Google или Facebook вместо своих учетных данных для этого конкретного сайта, вы уже использовали OAuth!
Процесс OAuth включает 3 шага:
- Создайте URL-адрес авторизации
- Получить код авторизации
- Обмен кода авторизации на токен доступа
Чтобы запустить процесс OAuth, нам нужно создать специальный URL-адрес авторизации, который отправляет пользователей на ORCID экран входа. Этот URL состоит из Конечная точка авторизации, плюс параметры которые идентифицируют вашу организацию и разрешения, которые вы хотите запросить.
| Параметр | Описание | Пример |
|---|---|---|
| ответ_тип | код | |
| сфера | Действия API, для которых вы хотите запросить разрешение, из списка ORCID Области | /человек/обновление /деятельность/обновление / read-limited / аутентифицировать |
| ID клиента | Ваш идентификатор клиента-участника (выданный ORCID) | [ПРИЛОЖЕНИЕ- ***] |
| URI перенаправления | Страница, которую увидят пользователи после завершения процесса авторизации. (Для этого урока это будет Google OAUth Playground) | https://developers.go ogle.com/oauthplayground |
Чтобы запросить разрешение на добавление/обновление действий (принадлежности, финансирование, работы, рецензирование, исследовательские ресурсы), а также на добавление/обновление личных элементов (другие имена, ключевые слова, страны, URL-адреса исследователей, веб-сайты и личные внешние идентификаторы) и читать ORCID запись, URL авторизации будет:
https://sandbox.orcid.org/oauth/authorize?client_id=[APP-****************]&response_type=code&scope=/read-limited%20/activities/update%20/person/update&redirect_uri=https://developers.google.com/oauthplaygroundНо мы можем использовать игровую площадку Google OAuth, чтобы помочь нам создать URL-адрес авторизации.
- Добавьте /activities/update, /person/update, /read-limited в поле областей и нажмите Авторизовать API.
URL-адрес авторизации был бы создан с использованием информации, которую вы ввели в поля конфигурации и области действия.
- An ORCID появится экран входа; войдите в свою учетную запись Sandbox с адресом электронной почты и паролем, которые вы использовали для создания ORCID учетную запись в начале этого руководства. После входа в систему появится экран OAuth. Имя клиента и соответствующие области будут отображаться на этом экране. Для предоставления доступа необходимо нажать 'Разрешить доступ'
- После предоставления разрешения вы будете перенаправлены обратно на игровую площадку Google OAuth, поскольку это был URI перенаправления, связанный с вашими учетными данными Sandbox. 6-значный код авторизации появится в конце URI перенаправления в адресной строке браузера (и под Шаг 2 раздел в левой части страницы на игровой площадке google oauth)
Secure https://developers.google.com/oauthplayground/code=s536Z5Получив код авторизации, вы можете обменять его на токен доступа и аутентификацию. iD пользователя, вошедшего в систему, которые вам понадобятся для выполнения действий API, для которых вы запросили разрешение.
В реальной ситуации этот обмен будет выполняться вашей системой с использованием языка программирования, такого как PHP, Java или Ruby on Rails. В этом руководстве мы будем использовать Google OAuth Playground для имитации веб-приложения.
- Нажмите «Обменять код авторизации для токенов»
Как только вы нажмете «Код авторизации биржи для токеновВаш токен доступа и аутентифицированный iD появится в Ответ на запрос раздел справа. См. пример ниже:
{
"name": "Sophia Garcia"
"access_token": "53737721-9cdb-442a-8b77-409609bb5e43",
"expires_in": 631138518,
"token type": "bearer",
"orcid":
"0000-0002-4456-8947"
"scope": "read-limited /activities/update person/update "
"refresh token": "cOfc38fd-291e-4633-a365-6f4afa304344"
}- Сохраните этот токен!
Важно сохранить токен, который вы получили на шаге выше, так как вы можете легко создавать любые вызовы, которые вам нужно сделать с его помощью. Мы рекомендуем вам сохранить полный ответ обмена токенами
Теперь вы получили аутентифицированный идентификатор и разрешение от пользователя на чтение его ORCID записывать и обновлять свои ORCID записи.