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 - Нажмите на свое имя в правом верхнем углу.
- Нажмите Инструменты разработчика из пункта меню
Примечание: Чтобы получить доступ к инструментам разработчика, вы должны подтвердить свой адрес электронной почты. Если вы еще не подтвердили свой адрес электронной почты, вам будет предложено сделать это на этом этапе. - Нажмите «Зарегистрироваться бесплатно» ORCID общедоступный API».
- Прочтите и примите условия обслуживания, когда будет предложено.
Зарегистрируйте заявку
- После принятия условий использования вы будете перенаправлены обратно в Инструменты разработчика (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools). Заполните представленную форму, чтобы зарегистрировать новое приложение.
- Имя и фамилия: Имя вашего приложения. Это будет показано пользователям, когда они предоставят вашему приложению разрешение на получение своих ORCID iD, и он будет отображаться в их Список доверенных организаций. Мы рекомендуем использовать название вашей организации или службы (например, название журнала).
- Cайт: Веб-сайт, который пользователь может посетить, чтобы узнать больше о вашем приложении. Это будет отображаться в их Список доверенных организаций.
- Описание: Информация о приложении, которое вы разрабатываете, и о том, как вы будете использовать пользовательский ORCID я бы. Это будет отображаться для пользователей на экране OAuth.
- Перенаправить URI: как только пользователь авторизует ваше приложение, он будет возвращен на указанный вами URI. Вы должны указать эти URI заранее, иначе ваши пользователи интеграции столкнутся с ошибкой.
- Только URI HTTPS принимаются в производство.
- Домены зарегистрированы ДОЛЖЕН точно соответствуют используемым доменам, включая субдомены.
- Зарегистрируйте все URI перенаправления полностью, где это возможно Это самый безопасный вариант, который мы рекомендуем. Для получения дополнительной информации об URI перенаправления см. FAQ
- В общедоступных приложениях API должен быть зарегистрирован хотя бы один URI перенаправления.
- Для тестирования вы можете автоматически добавить URI Google OAuth Playground, щелкнув «+ Google OAuth Playground» в разделе «Проверить URI перенаправления» или ORCID Публичный API Swagger, нажав «+»ORCID публичный чванливый интерфейс ».
- Для получения дополнительной информации см. О перенаправлении URI.
- Щелкните значок Сохранить внизу формы, чтобы сгенерировать учетные данные API.
- Чтобы просмотреть свои учетные данные API, нажмите «Показать подробности».
- Ваши учетные данные API - Клиент ID и Client Secret - отображаются сразу под вашими URI перенаправления. Ниже ваших учетных данных приведены примеры URL-адресов и вызовов API с предварительно заполненными учетными данными.
Используйте свои учетные данные
Теперь, когда у вас есть учетные данные, пора начать использовать ORCID Публичный API!
Обратите внимание, что мы можем передать ваши учетные данные членскому API, если вы станете ORCID член.