ORCID предлагает общедоступный API, который позволяет организациям, которые не ORCID участников для подключения своих систем и приложений к ORCID реестр с межмашинным взаимодействием. API представляет собой спокойный API и поддерживает как XML, так и JSON.
Публичный API можно использовать для следующих функций:
- Войдите в свою систему с помощью ORCID
- Собрать проверенных пользователей ORCID ID
- Получить общедоступные данные от пользователя ORCID запись
- Общедоступный поиск ORCID данные реестра
Мы рекомендуем разработчикам протестировать общедоступный API в сервер тестирования песочницы перед использованием рабочей версии. Ниже приведены шаги по регистрации для получения учетных данных общедоступного API как в тестовой среде, так и в рабочей среде.
- Войдите в свой ORCID запись:
Производственный сервер: https://orcid.org/signin
Сервер тестирования песочницы: https://sandbox.orcid.org/signin - Нажмите на свое имя в правом верхнем углу.
- Нажмите Инструменты разработчика из пункта меню
Примечание: Чтобы получить доступ к инструментам разработчика, вы должны подтвердить свой адрес электронной почты. Если вы еще не подтвердили свой адрес электронной почты, вам будет предложено сделать это, прежде чем вы сможете зарегистрироваться для получения учетных данных общедоступного API. - Прочитайте и согласитесь с 'ORCID Условия обслуживания публичных API
- Нажмите «Зарегистрироваться для ORCID Кнопка «Учетные данные публичного API».
Заполнение формы сведений о заявке
- После того, как вы зарегистрируетесь для получения учетных данных Public API, вы будете перенаправлены обратно в Инструменты разработчика (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
- Вам необходимо заполнить форму сведений о заявке, представленную для регистрации новой заявки.
- ФИО: Имя вашего приложения. Это будет показано пользователям, когда они предоставят вашему приложению разрешение на получение своих ORCID iD, и он будет отображаться в их Список доверенных организаций. Мы рекомендуем использовать название вашей организации или службы (например, название журнала).
- URL приложения: Веб-сайт, который пользователь может посетить, чтобы узнать больше о вашем приложении. Это также будет отображаться в их Список доверенных организаций.
- Описание приложения: Информация о приложении, которое вы разрабатываете, и о том, как вы будете использовать пользовательский ORCID я бы. Это будет отображаться для пользователей на экране OAuth.
Добавление Перенаправить URI
Как только пользователь авторизует ваше приложение, он будет возвращен на указанный вами URI. Вы должны указать эти URI заранее, иначе ваши пользователи интеграции столкнутся с ошибкой.
- Введите свой URI перенаправления в соответствующее поле.
- Если вам нужно ввести более 1 URI перенаправления, нажмите «Добавить другой URI перенаправления».
Пожалуйста, обратите внимание:
- Только URI HTTPS принимаются в производство
- Домены зарегистрированы ОБЯЗАТЕЛЬНО точно соответствуют используемым доменам, включая субдомены
- Зарегистрируйте все URI перенаправления полностью, где это возможно. Это самый безопасный вариант, который мы рекомендуем. Для получения дополнительной информации об URI перенаправления см. часто задаваемые вопросы по URI перенаправления
Сохранение вашего приложения
После того, как вы заполнили форму заявки и добавили свои URI перенаправления, вы можете сохранить свое приложение.
- Нажмите «Сохранить мою заявку и сгенерировать мой идентификатор клиента и секрет».
Вы будете перенаправлены обратно на страницу инструментов разработчика, которая теперь будет включать ваши учетные данные клиента Public API.
Обновление ваших учетных данных
Внести изменения в информацию о приложении очень просто.
- Отредактируйте соответствующую информацию и нажмите «Сохранить приложение».
Используйте свои учетные данные
Теперь, когда у вас есть учетные данные, пора начать использовать ORCID Публичный API!
Обратите внимание, что мы можем передать ваши учетные данные членскому API, если вы станете ORCID член в будущем.
Просмотрите наш Группа пользователей API разделы для получения дополнительной информации о настройке интеграции с общедоступным API. Однако для получения максимальной выгоды от ORCID, мы рекомендуем вам присоединиться ORCID в качестве члена организации, который предлагает доступ к дополнительным функциям, личную помощь нашей команды по интеграции и, конечно же, помогает поддерживать нашу работу.