ORCID предлагает несколько API, которые позволяют вашим системам подключаться к ORCID реестр, включая чтение и запись в ORCID записи. Некоторые функции API доступны всем бесплатно (Public API); другие доступны только для ORCID членские организации (API для членов и премиум-членов).
Любой желающий может бесплатно протестировать API на нашем тестовом сервере в песочнице. и мы поощряем все организации, использующие ORCID - члены и не члены - присоединиться к нашему Группа пользователей API, где вы можете задать вопросы и узнать о новых технических разработках.
Ищите часто задаваемые вопросы здесь:
Основы
Элементы (работы, трудоустройство, финансирование, экспертная оценка и т. Д.) Могут быть добавлены в ORCID запись вручную или с помощью ORCID членский API. Если вы частное лицо и хотите обновить свою запись, посетите наш раздел помощи по этому поводу здесь. Если вы являетесь участником и хотите добавить элементы в ORCID записи, вам понадобится следующее:
- Разрешение исследователей
- Учетные данные API участника
- И либо:
- Система поставщика, которая интегрируется с ORCID Членский API
- Ваша собственная система, которая интегрируется с ORCID Членский API
Полное руководство для участников, использующих API для записи элементов, можно найти по ссылке на наше руководство по API ниже:
Для поддержки социальной составляющей мы предлагаем инструментарий Информационные ресурсы чтобы помочь вам разработать кампанию в поддержку вашей интеграции и сообщить вашим исследователям:
- Что ORCID есть.
- Почему ваша система собирает iD и как ваша система будет выполнять задачи, например обновлять их записи.
- Почему ваши исследователи выиграют от создания ORCID iD и подключить их iD к вашей системе.
- Как ORCID приносит пользу более широкому глобальному исследовательскому сообществу.
Мы будем постоянно создавать эту «библиотеку» ресурсов на основе отзывов сообщества. Если у вас есть идея, что вы хотели бы увидеть, пожалуйста, свяжитесь с нами.
Интегрируя ORCID в вашу систему позволяет вашей организации собирать проверенные ORCID iDs и добавьте их к своим собственным данным. В то же время исследователь предоставляет организации разрешение на чтение и запись в свои сети и обратно. ORCID записи.
Чтобы добиться этой цели, организации ОБЯЗАТЕЛЬНО получать подлинности ORCID ID используя ORCID API OAuth. Это означает, что они включают в себя ORCID фирменная кнопка или ссылка в их системе, при нажатии на которую пользователю предлагается войти в свою учетную запись. ORCID записи.
После входа в систему пользователю будет предложено авторизовать доступ к системе с запросом его ORCID iD
пользователя ORCID iD и имя на ORCID запись (в зависимости от настроек видимости) возвращается в организацию в рамках этого процесса. Затем система может запросить дополнительные данные у ORCID API.
Описанный выше рабочий процесс сбора аутентифицированных API доступен как в ORCIDобщедоступные и членские API. Первый доступен для бесплатного использования некоммерческими сервисами.
Процесс получения разрешения на добавление или обновление данных о пользователе. ORCID запись использует OAuth, как описано в нашем 3 Часто задаваемые вопросы по протоколу OAuth, Только ORCID участники могут использовать API участников, чтобы запрашивать разрешения на обновление. Проще говоря, это работает так:
- Ваша локальная система создает специальную ссылку
- При нажатии пользователь отправляется на ORCID, входит в систему и дает разрешение
- ORCID отправляет пользователя обратно в вашу систему с «кодом авторизации»
- Ваша система обменивает этот код на "токен доступа"
- Маркер доступа позволяет обновлять запись пользователя
ORCID стремится обеспечить прозрачные и заслуживающие доверия связи между исследователями, их вкладом и их филиалами, предоставляя уникальный, постоянный идентификатор, который люди могут использовать, когда они участвуют в исследовательской, научной и инновационной деятельности. Обеспечение того, чтобы правильный ORCID iD связан с правильным исследователем, является решающим шагом в построении надежности ORCID набор данных и более широкая экосистема научных коммуникаций. По этой причине, ORCID не разрешает ручной сбор или ввод ORCID идентификаторы в любом рабочем процессе, где можно собрать ORCID удостоверения личности непосредственно от самих рекордсменов.
Исследователи могут легко и безопасно делиться своими ORCID идентификаторы систем, с которыми они взаимодействуют, что доказывает, что они владеют своими ORCID идентификатор. Эти системы затем могут обмениваться информацией об исследовательской деятельности с другими системами, что создает цепочку проверенных и заслуживающих доверия утверждений об исследовательской деятельности. Конечным результатом является то, что правильный человек связан с правильными действиями в широком диапазоне научных информационных рабочих процессов.
Для получения дополнительной информации см .: https://info.orcid.org/collecting-and-sharing-orcid-ids/
Вы можете облегчить жизнь своим пользователям, подключив подтвержденную информацию к их ORCID записи. Вы также поможете укрепить доверие к научным коммуникациям и, поддерживая эти данные в актуальном состоянии, вы сможете уменьшить бремя отчетности для ваших пользователей и улучшить качество данных.
ORCID для исследовательских организаций
Помимо использования в качестве постоянного идентификатора для ваших исследователей, ORCID может помочь вам взять под контроль использование названия вашего учреждения в исследовательских системах. В сочетании с другими постоянными идентификаторами ORCID позволяет вам авторитетно утверждать, что ваши сотрудники, преподаватели и студенты связаны с вашим учреждением. Вы также можете использовать ORCID API-интерфейсы для получения уведомлений об исследовательской деятельности в режиме реального времени, для автоматического обновления форм и отслеживания карьеры выпускников.
ORCID для финансирующих организаций
Путем встраивания ORCID iDs в ваших рабочих процессах финансирования, вы можете надежно связать своих получателей грантов и программы финансирования - и сэкономить время каждого и уменьшить количество ошибок, вызванных вводом информации вручную. С использованием ORCID в вашей системе (ах) вы можете сыграть свою роль в создании надежной инфраструктуры исследовательской информации, установив связи между людьми и грантами, которые вы им присуждаете.
ORCID для издателей
Исследователи лежат в основе всего, что делают научные и исследовательские издатели. Точная информация об авторе и рецензенте имеет жизненно важное значение для индексирования, поиска и обнаружения, отслеживания публикаций, определения финансирования и использования ресурсов, а также для поддержки рецензирования.
ORCID служит информационным центром, позволяя вашим авторам и рецензентам надежно подключаться к своим материалам и обмениваться информацией из своих ORCID записывайте, как они взаимодействуют с вашими издательскими системами. Сбор идентификаторов для всех ваших авторов и рецензентов в процессе публикации — будь то для книг, журналов, наборов данных, композиций, презентаций, кода или множества других работ — позволяет легко обмениваться информацией, гарантирует, что исследователи могут дать согласие на обмен, экономит время и усилия исследователей, снижает риск ошибок и, что особенно важно, позволяет исследователям получить признание, которого они заслуживают за важную работу, которую они выполняют.
Запрос членских организаций ORCID Учетные данные API участника на рабочем (рабочем) сервере, заполнив Форма клиентского приложения для API участников производства. Перед выдачей учетных данных API-интерфейса рабочего члена ORCID Аудиторская группа/Руководитель консорциума рассмотрит демонстрацию вашей интеграции в ORCID песочница. Это дает нам возможность увидеть великолепные интеграции, которые вы создали, и предложить улучшения рабочих процессов, а также проверить, соответствуют ли все интеграции нашим лучшим практикам и минимальным требованиям для запуска.
Чтобы предоставить демонстрацию вашей системы, вам необходимо настроить рабочую интеграцию с ORCID песочница, которая ORCID команда может просмотреть. Есть несколько способов поделиться своей рабочей интеграцией с песочницей:
- Рекомендуется: Живая демоверсия: Свяжитесь с нами, чтобы запланировать живую демонстрацию. Мы предоставим программное обеспечение для совещаний, которое позволит вам поделиться своим экраном, чтобы вы могли продемонстрировать свою интеграцию.
- Тестовый сайт: Если ваш сайт разработки общедоступен, отправьте нам URL вместе с тестовыми учетными данными (при необходимости) для доступа к вашей системе и инструкциями, описывающими, как использовать вашу систему ORCID Особенности. Предоставьте дополнительную документацию, чтобы проверить, что мы не сможем увидеть со стороны пользователя, например, используемую версию API, какие данные хранятся в вашей системе и т. Д.
- Скринкаст или скриншоты:Отправить запись или набор скриншотов с описаниями, четко объясняющими и демонстрирующими, как работает ваша интеграция на каждом этапе, включая то, что произойдет, если пользователь откажет в доступе или отключит свой идентификатор. Обязательно предоставьте дополнительную документацию, чтобы проверить все, что мы не сможем увидеть со стороны пользователя, например, используемую версию API и способ хранения данных.
интеграцию
Учетные данные открытого клиента предоставляются отдельным лицам, а не организациям. Учетные данные нельзя передавать от одного человека к другому, но их можно преобразовать в учетные данные члена API, если согласие получено от всех сторон и организация является активным членом ORCID.
Перемещение идентификатора клиента в API участника не изменит идентификатор клиента, изменится только секрет клиента, и вы сохраните количество подключенных идентификаторов с разрешением только на чтение.
При преобразовании клиента Public API в клиент Member API Условия обслуживания публичных клиентов больше не применяются, и их заменяют условия членского соглашения.
Для переноса нам понадобится:
- Подтверждение идентификатора клиента Public API, который будет преобразован.
- Основное контактное лицо организации и держатель записи текущего идентификатора клиента Public API согласны с изменением Условий обслуживания. (Держатель записи должен быть сотрудником, подрядчиком или должностным лицом организации-члена). Мы будем вести учет согласия обеих сторон.
- Дата/время для миграции. В рамках этой миграции мы обновим идентификатор клиента и отправим вам новый секрет клиента в зашифрованном электронном письме. Обратите внимание, что после обновления клиента ваша интеграция не будет работать, пока вы не обновите секрет клиента. Вот почему нам нужно зафиксировать дату и время для этого и предотвратить неудобства для пользователей.
Чтобы преобразование было завершено, вам необходимо обновить:
- Старый секрет клиента в новый секрет клиента.
- Хост API из pub.orcid.org в api.orcid.org.
С преобразованным идентификатором клиента Member API вы можете обновить области, чтобы добавить области API-членов. Для этого потребуется авторизация пользователей, и будут созданы новые токены доступа, включающие новые области/разрешения.
Обратите внимание, что мы не можем преобразовать учетные данные клиентов Member API в учетные данные Public API.
Для поддержки социальной составляющей мы предлагаем инструментарий Информационные ресурсы чтобы помочь вам разработать кампанию в поддержку вашей интеграции и сообщить вашим исследователям:
- Что ORCID есть.
- Почему ваша система собирает iD и как ваша система будет выполнять задачи, например обновлять их записи.
- Почему ваши исследователи выиграют от создания ORCID iD и подключить их iD к вашей системе.
- Как ORCID приносит пользу более широкому глобальному исследовательскому сообществу.
Мы будем постоянно создавать эту «библиотеку» ресурсов на основе отзывов сообщества. Если у вас есть идея, что вы хотели бы увидеть, пожалуйста, свяжитесь с нами.
Вы можете запросить учетные данные API участника тестовой среды для создания и тестирования вашего приложения. Эти учетные данные позволяют вам выполнять вызовы API-интерфейса премиум-члена песочницы для чтения, записи и обновления. ORCID записи. Доступ к тестовой среде "песочницы" доступен каждому, даже если вы не являетесь ORCID членская организация.
Внимание: Если вы используете ORCID сертифицированная система поставщика услуг, которая уже поддерживает ORCID, вам не нужно регистрироваться для получения учетных данных API песочницы, если вы не хотите опробовать ORCID функциональность интеграции в среде Sandbox.
Песочница позволяет вам создавать тестовые учетные записи пользователей и развивать свою интеграцию, не беспокоясь о влиянии данных на живые (производственные) ORCID Реестр. Песочница ведет себя так же, как и продакшн. ORCID Реестр с несколько исключений.
Создание тестовой учетной записи
Чтобы проверить ORCID API и вызовы API, такие как чтение и добавление информации в ORCID запись, вам также потребуется создать тест ORCID запись в песочнице. Это можно сделать через пользовательский интерфейс, как на продакшене. ORCID Реестр. Перейти к https://sandbox.orcid.org/register и зарегистрируйте аккаунт.
Адреса электронной почты Mailinator
Сервер песочницы отправляет электронные письма только на Mailinator Адреса электронной почты (@mailinator.com), чтобы непреднамеренно не спамить почтовые серверы. Вы не получите электронное письмо с подтверждением или уведомление о сбросе пароля, если не используете адрес @mailinator.com, а проверка требуется для внесения любых изменений в записи песочницы вручную. Узнайте больше об их бесплатных общедоступных почтовых ящиках здесь. Если вы не хотите использовать Mailinator адрес, затем запишите свое имя пользователя и пароль (поскольку вы будете использовать их для авторизации вашего приложения при тестировании) и свяжитесь с нами, чтобы запросить помощь с проверкой.
Mailinator это служба электронной почты, которая имеет общедоступную бесплатную услугу и частную платную услугу. Для тестирования вы можете воспользоваться совершенно бесплатным публичным сервисом. Узнайте больше об их уровнях здесь.
Mailinator - это сторонний сервис, который не управляется и не поддерживается ORCID. Мы рекомендуем вам ознакомиться с принципами работы этой службы и ее ограничениями, прежде чем использовать эти адреса.
Интеграции должны хранить больше, чем просто ORCID записи. Ваша система должна будет уметь:
- Принять и хранить ORCID iDs: вашей системе необходимо знать iD ORCID запись для отображения iD и правильно обновиться. Сохраните его вместе с информацией исследователя, которая возвращается в ответе на обмен токенами. Мы рекомендуем хранить полный https URI: https://orcid.org/0000-0001-5727-2427.
- Принимать и хранить постоянные токены доступа и обновить токены: Токены доступа можно использовать для чтения и обновления записей, а также для обозначения того, что iD был аутентифицирован. Токены доступа действительны в течение примерно 20 лет или до тех пор, пока пользователь не отзовет их. Мы также рекомендуем хранить область действия токена, срок действия токена и обновить токены. При необходимости токены обновления можно использовать для создания новых токенов доступа с теми же или ограниченными областями действия. Храните данные токена доступа вместе с информацией исследователя.
- Принять и хранить поставить коды : Каждый элемент, который вы добавляете в ORCID Реестр будет возвращен с кодом размещения от ORCID API. Сохраните этот 6-значный код размещения вместе с элементом в вашей системе. С его помощью вы сможете определить, какой элемент необходимо прочитать, обновить или удалить.
- Предоставьте сообщения об ошибках и контакт в службу поддержки, если взаимодействие идет не так, как ожидалось.
Мы рекомендуем разработчикам протестировать общедоступный API в сервер тестирования песочницы перед использованием производственной версии. Ниже приведены инструкции по регистрации учетных данных общедоступного API как в песочнице, так и в производственной среде.
- Войдите в свой ORCID запись:
Производственный сервер: https://orcid.org/signin
Сервер тестирования песочницы: https://sandbox.orcid.org/signin - Нажмите на свое имя в правом верхнем углу.
- Нажмите Инструменты разработчика из пункта меню
Примечание: Чтобы получить доступ к инструментам разработчика, вы должны подтвердить свой адрес электронной почты. Если вы еще не подтвердили свой адрес электронной почты, вам будет предложено сделать это, прежде чем вы сможете зарегистрироваться для получения учетных данных общедоступного API. - Прочитайте и согласитесь с 'ORCID Условия обслуживания публичных клиентов
- Нажмите «Зарегистрироваться для 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 член в будущем.
Мы ожидаем, что все интеграции участников будут соответствовать ряду требований. В ORCID команда обеспечит выполнение этих требований в рамках процесса проверки интеграции.
- Используйте OAuth удостоверять подлинность ORCID iD (не позволяйте пользователям искать или вводить ORCID IDs.)
- Представьте экран авторизации OAuth в соответствии с нашими методических рекомендаций
- Включить ORCID фирменная кнопка или ссылка на вашем сайте, чтобы инициировать аутентификацию iD.
- Используйте HTTPS для URI перенаправления вашего сайта и на ORCID Вызовы API
- Принимать и хранить все данные, возвращаемые при обмене токенами, вместе с данными пользователя в вашей системе.
- Используйте соответствующие прицелы и методы запроса (например, вызовы POST для добавления новой информации и вызовы PUT для обновления существующей информации)
- Публично отображать аутентифицированные ORCID IDs. iD должны отображаться после наших товарный знак и iD отображать рекомендации.
- Не попросить пользователей изменить настройки видимости элементов на их ORCID запишите, чтобы использовать вашу интеграцию.
Вам нужно будет заполнить форма для регистрации клиентского приложения. Ниже приведен краткий обзор требуемых полей:
Название организации: Ваш ORCID название членской организации
Основной контактный адрес электронной почты для учетных данных: Мы будем использовать этот адрес электронной почты, чтобы отправить вам учетные данные в зашифрованном виде по электронной почте, а также связаться с вами, если при вашей интеграции возникнут какие-либо вопросы или ошибки.
Дополнительный адрес электронной почты для пароля: адрес электронной почты, на который мы можем отправить ваш зашифрованный пароль электронной почты.
Имя вашего клиента: Это будет ваш ORCID название членской организации. Если у вас более одной интеграции, мы добавим приложение к имени.
URL домашней страницы вашего приложения: Отображается в виде ссылки в списке доверенных организаций среди пользователей. ORCID страница доверенных лиц. Это должна быть ссылка на вашу организацию или на главную страницу вашего приложения.
Краткое описание вашего клиентского приложения: этот текст будет отображаться на экране авторизации со значком вопросительного знака для ваших пользователей интеграции. Требуется краткое описание вашей интеграции.
URI перенаправления: Как только пользователь авторизует ваше приложение, он будет возвращен на указанный вами URI. Вы должны указать эти URI заранее, иначе ваши пользователи интеграции столкнутся с ошибкой.
- Принимаются только HTTPS URI.
- Зарегистрированные домены должны точно соответствовать используемым доменам, включая субдомены.
- Зарегистрируйте все URI перенаправления полностью, где это возможно.
- Требуется более 5 URI перенаправления? Укажите это в примечаниях к ORCID персонала.
Примечания для ORCID персонал: Используйте это поле, чтобы ORCID сотрудники знают что-либо дополнительное о вашем запросе или вашей интеграции
Мастера поиска и создания ссылок это интеграции, которые можно использовать для импорта элементов (в основном работает) в ORCID Реестр. Они должны пройти тестирование между интегратором и ORCID прежде, чем они могут быть выпущены в рабочую среду реестра.
В зависимости от ваших ответов на приведенные ниже вопросы, ваша интеграция может быть подходящим кандидатом для поиска и ссылок — пожалуйста, свяжитесь с нами, чтобы обсудить это подробнее, прежде чем приступать к разработке мастера поиска и ссылок:
- Какая целевая аудитория у мастера? Например, авторы, рецензенты или соискатели грантов на национальном, дисциплинарном или глобальном уровне.
- Насколько велика ожидаемая аудитория?
- Будет ли он обслуживать население, которое в настоящее время недостаточно обслуживается существующими волшебниками? Например, исследования, посвященные определенному языку или дисциплине, или материалы нового типа.
- Как вы обеспечите удобство работы с мастером?
- Какую поддержку пользователей вы будете оказывать?
- Есть - или будет - ORCID назначить мастера в вашей организации, например, менеджера по продукту?
- Как вы убедитесь, что ORCID iD аутентифицированы?
- Вы - или будете - глотать и отображать ORCID iD на вашей платформе?
- Включен ли поиск по вашей платформе с помощью iDs?
Пожалуйста, ознакомьтесь с нашим Поиск и создание ссылок Больше подробностей.
Запрос членских организаций ORCID Учетные данные API участника на рабочем (рабочем) сервере, заполнив Форма клиентского приложения для API участников производства. Перед выдачей учетных данных API-интерфейса рабочего члена ORCID Аудиторская группа/Руководитель консорциума рассмотрит демонстрацию вашей интеграции в ORCID песочница. Это дает нам возможность увидеть великолепные интеграции, которые вы создали, и предложить улучшения рабочих процессов, а также проверить, соответствуют ли все интеграции нашим лучшим практикам и минимальным требованиям для запуска.
Чтобы предоставить демонстрацию вашей системы, вам необходимо настроить рабочую интеграцию с ORCID песочница, которая ORCID команда может просмотреть. Есть несколько способов поделиться своей рабочей интеграцией с песочницей:
- Рекомендуется: Живая демоверсия: Свяжитесь с нами, чтобы запланировать живую демонстрацию. Мы предоставим программное обеспечение для совещаний, которое позволит вам поделиться своим экраном, чтобы вы могли продемонстрировать свою интеграцию.
- Тестовый сайт: Если ваш сайт разработки общедоступен, отправьте нам URL вместе с тестовыми учетными данными (при необходимости) для доступа к вашей системе и инструкциями, описывающими, как использовать вашу систему ORCID Особенности. Предоставьте дополнительную документацию, чтобы проверить, что мы не сможем увидеть со стороны пользователя, например, используемую версию API, какие данные хранятся в вашей системе и т. Д.
- Скринкаст или скриншоты:Отправить запись или набор скриншотов с описаниями, четко объясняющими и демонстрирующими, как работает ваша интеграция на каждом этапе, включая то, что произойдет, если пользователь откажет в доступе или отключит свой идентификатор. Обязательно предоставьте дополнительную документацию, чтобы проверить все, что мы не сможем увидеть со стороны пользователя, например, используемую версию API и способ хранения данных.
Веб-перехватчики позволяют премиум-членам «смотреть» ORCID записи и получать уведомления о любых изменениях.
Используя API и учетные данные клиента премиум-класса, премиум-члены могут зарегистрировать URL-адрес обратного вызова для каждой аутентифицированной ORCID iD что они хотят отслеживать. В ORCID Владелец записи не должен предоставлять конкретной организации разрешение на регистрацию URL-адреса, но фактический обмен данными основан на уровнях конфиденциальности, установленных ORCID iD держатель.
С этим на месте ORCID будет уведомлять этот указанный URL, отправив запрос, когда есть изменения в ORCID записи.
Метаданные
Все разделы аффилированности используют один и тот же набор метаданных в API:
- Название организации:* Название организации на высшем уровне (например, «Бостонский университет», а не «Медицинский факультет Бостонского университета»).
- Город организации: * Город, в котором базируется организация.
- Регион организации: Регион, в котором расположена организация.
- Страна организации * страна организации. Это должно быть заполнено двухбуквенный код страны ISO 3166 Alpha-2.
- Идентификатор организации (ROR, GRID, Ringgold** или LEI):* Уникальный идентификатор организации и ее источника. Мы рекомендуем использовать идентификатор головной организации в рамках филиала, а не подразделения или отдела.
- Роль / Должность: Занимаемая должность или присвоенная или подлежащая присуждению степень.
- Отдел: Любое подразделение головной организации.
- URL: URL-адрес ресурса о принадлежности
- Дата начала: Дата начала отношений между исследователем и организацией (может быть указана с точностью до года, месяца и дня).
- Дата окончания: Дата окончания отношений между исследователем и организацией (может быть указана с точностью до года, месяца и дня)
- Внешний постоянный идентификатор, описывающий принадлежность: Уникальный идентификатор фактического утверждения о принадлежности
* Обозначает обязательное поле.
**Хотя идентификаторы Ringgold все еще существуют в ORCID реестр, по состоянию на 1 августа 2023 г., ORCID больше не получает обновлений базы данных идентификаторов организаций RINGGOLD, используемой нашим реестром, и мы не сможем обрабатывать или использовать идентификаторы RINGGOLD, созданные после этой даты. Посмотрите наш FAQ для дополнительной информации.
Под биографической частью ORCID запись:
Также известен как: Это может включать сокращенное имя, варианты, включающие инициалы для одного или нескольких имен, отчество (имена), прежнее или альтернативное имя (имена) или имя (имена) в другом наборе символов. Каждое имя должно быть добавлено как отдельный элемент. Это свободное текстовое поле до 255 символов.
Веб-сайты: Этот раздел включает описание (необязательно) и URL-адрес веб-сайта (обязательно)
Страна: Раздел "Кантри" ORCID Запись позволяет исследователям и членским организациям добавлять одну или несколько стран, в которых они проводят исследования или являются темой их исследования. Элементы в списке стран получены из международного стандарта ISO 3166 для кодов стран и регионов.
Внешние идентификаторы (другие идентификаторы): Этот раздел может быть добавлен только членскими организациями. Обратите внимание, что, хотя многие организации собирают другие внешние идентификаторы для своих исследователей, например идентификаторы авторов Scopus, только издатель этих идентификаторов может утверждать их авторитетно. Поэтому мы настоятельно рекомендуем вашей организации добавлять только те идентификаторы, которые ваша система (-а) создала и использует для идентификации исследователей. Этот раздел включает четыре компонента (* указывает на обязательное поле):
- Тип удостоверения личности *
- Значение идентификатора *
- ID отношения *
- URL-адрес идентификатора
- Заголовок:* Название работы
- Подзаголовок: Подзаголовок к работе
- Переведенное название: Заголовок, под которым произведение появляется на другом языке, язык переведенного заголовка записывается как атрибут
- Название журнала: Название более крупного собрания, к которому принадлежит работа, например журнала для журнальных статей или книги для глав в книгах. Несмотря на то, что это название журнала, его можно использовать для других работ.
- Краткое описание: Краткое описание или аннотация работы.
- Тип цитирования: Формат цитирования. Это поле выбирается из списка, содержащего следующие значения: APA, BIBTEX, CHICAGO, HARVARD, IEEE, MLA, RIS, UNSPECIFIED, VANCOUVER
- Ценность цитирования: Содержание цитаты
- Тип работы: Тип объекта работы. Это поле необходимо выбрать из поддерживаемые виды работ
- Дата публикации: Дата публикации работы. Мы рекомендуем использовать самую раннюю дату публикации
- Тип внешнего идентификатора: * Тип идентификатора. Это поле необходимо выбрать из поддерживаемые идентификаторы работ
- Внешний идентификатор: * Сам идентификатор
- Внешний идентификатор-URL: URL-адрес, в который разрешается идентификатор
- Внешний идентификатор-отношения: * Идентификаторы, которые применяются только к добавляемой работе, будут помечены как Self. Идентификаторы, которые применяются к более крупной коллекции, к которой принадлежит эта работа, будут иметь значение «Часть из». Идентификаторам, применимым к альтернативным версиям произведения, будет присвоено значение version-of. Идентификаторы, которые применяются к финансированию работы, будут установлены как финансируемые.
- Рабочий URL: URL-адрес, ссылающийся на работу
- Соавторы работы: Информация о лицах, создавших произведение
- Код языка: Язык, используемый для описания работы в предыдущих полях.
- Страна: Страна, в которой произведение было опубликовано или иным образом связано с
* Обозначает обязательное поле
Существует множество типов исследовательских ресурсов, от одноразовых реагентов до международных совместных проектов с специализированными учреждениями. ORCID поддерживает высокоуровневую модель, которая может ссылаться на другие места для получения подробных сведений о предметной области.
Существует четыре типа ресурсов высокого уровня:
Тип ресурса | Определение | Примеры |
Инфраструктура | Объект, здание или другое физическое пространство, используемое для проведения исследований. | Источник нейтронного расщепления, животноводческий комплекс, анклав данных, археологические раскопки, массив телескопов. корабли, самолеты, фермы, лаборатории |
Транспортировка | Объект или группа объектов, используемых в исследовательских целях; может быть материальным или цифровым | Океанские миссии, полевые кампании, совместные наборы данных или ресурсы, коллекция раритетов; музейная коллекция, коллекция биологических образцов |
Подобрать оборудование | Оборудование, используемое в исследовательских целях | Микроскоп, компьютеры, посуда, образцы, материалы |
Услуга | Сервисы, используемые в исследовательских целях | Протеомический анализ, компьютерные услуги, анализ данных, логистическая поддержка, юридические услуги, копировальное редактирование, консультации экспертов или персонала |
В дополнение к типу ресурса, элемент ресурса исследования в пределах ORCID запись содержит следующую информацию. * указывает на обязательные позиции
- Заявка / Заголовок регистрации: * Это основное поле отображения исследовательских ресурсов, например, «Награда за нейтронный луч» или «Время луча и вычислительные ресурсы».
- ID предложения / регистрации: * Это публичный идентификатор (DOI, PURL и т. Д.) Для предложения или запроса на использование ресурса. В идеале этот идентификатор должен быть постоянным и указывать на общедоступную целевую страницу с информацией о предложении или запросе, такой как база данных наград или журнал пользователей ресурсов.
- Организаторы предложения: * Это организация, которая получает и обрабатывает предложения или запросы о ресурсах. Хост предложения может совпадать с хостом ресурса.
- Предложение принимающей организации iD * Это общедоступный идентификатор (один из ROR, GRID, Open Funder ID, LEI) для организации, управляющей процессом предложения или запроса.
- Ресурсы):* (до 100 года)
- Название ресурса: * - например, «Источник нейтронного расщепления»
- ID ресурса: * - из расширяемого списка допустимых типов PID (например, RRID, DOI, URI)
- Тип ресурса: * - одна из «Инфраструктуры», «Коллекции», «Оборудование» или «Услуги»
- Хост (и) ресурса: * Это организация, которая управляет Ресурсом или управляет им, например, национальная лаборатория, государственное учреждение или исследовательский университет.
- Идентификатор принимающей организации ресурса:* Это общедоступный идентификатор (один из ROR, GRID, Ringgold**, Open Funder ID, LEI) организации, на которой размещен ресурс.
- URL-адрес предложения: Ссылка на предложение
- Дата начала предложения: Дата начала доступа
- Дата окончания предложения: Дата окончания или окончания доступа
* Обозначает обязательное поле
**Хотя идентификаторы Ringgold все еще существуют в ORCID реестр, по состоянию на 1 августа 2023 г., ORCID больше не получает обновлений базы данных идентификаторов организаций RINGGOLD, используемой нашим реестром, и мы не сможем обрабатывать или использовать идентификаторы RINGGOLD, созданные после этой даты. Посмотрите наш FAQ для дополнительной информации.
- Роль:* Роль человека в процессе проверки, которую можно выбрать из: председателя, редактора, члена, организатора, рецензента.
- Идентификатор группы: * Групповой идентификатор, который используется для целей агрегации — для журнальных статей идентификатор по умолчанию — eISSN, который автоматически заполняется через интеграцию с базой данных ISSN. Обратите внимание, если вам нужно назначить идентификатор, отличный от ISSN, вам нужно будет создать его раньше.
- Созывающая организация *: Организация, организовавшая обзор - издатель журнала, организатор конференции, финансирующее агентство, профессорско-преподавательский состав и т. Д.
- Идентификатор организации: Постоянный идентификатор инициирующей организации. В настоящее время мы поддерживаем идентификаторы реестра ROR, Ringgold**, GRID, LEI или Crossref Funder. Обратите внимание: это не обязательное поле, но мы рекомендуем вам опубликовать эти данные, если они у вас есть.
- Данные обзора: * Эти данные относятся к деятельности по проверке, а не к тому, что было проверено.
- Тип: Тип проверки: проверка или оценка.
- Время: Дата завершения проверки. Это может быть общее (2008) или конкретное (2010-12-10)
- Идентификатор обзора: Уникальный, желательно разрешимый идентификатор предоставлено самим источником отзыва. Если обзор не является общедоступным, мы рекомендуем, чтобы он не содержал идентифицируемых данных, которые можно проследить до предмета обзора.
- URL обзора: Ссылка на представление обзора или записи обзора в Интернете
- Информация о теме обзора: Что бы ни рассмотрел рецензент
- Тип темы: Тип рецензируемого материала, например, журнальная статья, доклад на конференции.
- Это включает список видов работ И список типов грантов («Грант», «контракт», «награда», «вознаграждение») И исследование- «ресурс-предложение» И «неопределенное»
- Имя субъекта: Название проверяемого товара
- Внешний идентификатор субъекта: Уникальный идентификатор темы обзора, например, статья DOI
- Название контейнера темы: Название объекта, частью которого является предмет рецензирования, например, конференция, для которой рецензировалась статья.
- URL-адрес темы: URL-адрес рассмотренной темы
- Тип темы: Тип рецензируемого материала, например, журнальная статья, доклад на конференции.
* Обозначает обязательное поле
**Хотя идентификаторы Ringgold все еще существуют в ORCID реестр, по состоянию на 1 августа 2023 г., ORCID больше не получает обновлений базы данных идентификаторов организаций RINGGOLD, используемой нашим реестром, и мы не сможем обрабатывать или использовать идентификаторы RINGGOLD, созданные после этой даты. Посмотрите наш FAQ для дополнительной информации.
- Тип финансирования: * Тип предоставленного финансирования. Это поле выбирается из списка, содержащего следующие значения: Награда, Контракт, Грант, Заработная плата.
- Название финансирования: * Название статьи финансирования
- подзаголовок: Подзаголовок статьи о финансировании
- Переведенное название: Заголовок, под которым выделяется финансирование, на другом языке, язык переведенного заголовка записывается как атрибут
- Описание: Описание или краткая аннотация финансируемого проекта.
- Сумма: Стоимость награды
- Уникальный идентификатор финансирования: Добавьте столько из них, сколько известно вашей системе, так как это помогает в группировке по ORCID Records.
- Тип идентификатора финансирования: Используйте номер гранта, DOI, URI или идентификатор предложения.
- Значение идентификатора
- URL-адрес идентификатора (необязательно)
- Отношения: я / часть
Это указывает на связь статьи финансирования с идентификатором. Например, если статья финансирования предназначена для одной фазы многокомпонентного гранта, а идентификатор - для многокомпонентного гранта, тогда связь будет «частично из»; если идентификатор относится к индивидуальной фазе, то связь будет «собственное».
- Финансирующее агентство (организация): * Информация об организации, предоставившей финансирование
- Название агентства
- Адрес (город и страна)
- Идентификатор организации:
- Дата начала: Дата начала финансирования
- Дата окончания: Дата окончания финансирования
- Информация для авторов: Информация о лицах, получивших финансирование
- ORCID я бы: Команда ORCID iD каждого участника проекта финансирования; это должно включать только аутентифицированные ORCID ID
- Роль: Характер вклада исследователя
* Обозначает обязательное поле
Все разделы аффилированности используют один и тот же набор метаданных в API:
- Название организации:* Название организации на высшем уровне (например, «Бостонский университет», а не «Медицинский факультет Бостонского университета»).
- Город организации: * Город, в котором базируется организация.
- Регион организации: Регион, в котором расположена организация.
- Страна организации * страна организации. Это должно быть заполнено двухбуквенный код страны ISO 3166 Alpha-2.
- Идентификатор организации (ROR, GRID, Ringgold** или LEI):* Уникальный идентификатор организации и ее источника. Мы рекомендуем использовать идентификатор головной организации в рамках филиала, а не подразделения или отдела.
- Роль / Должность: Занимаемая должность или присвоенная или подлежащая присуждению степень.
- Отдел: Любое подразделение головной организации.
- URL: URL-адрес ресурса о принадлежности
- Дата начала: Дата начала отношений между исследователем и организацией (может быть указана с точностью до года, месяца и дня).
- Дата окончания: Дата окончания отношений между исследователем и организацией (может быть указана с точностью до года, месяца и дня)
- Внешний постоянный идентификатор, описывающий принадлежность: Уникальный идентификатор фактического утверждения о принадлежности
* Обозначает обязательное поле.
**Хотя идентификаторы Ringgold все еще существуют в ORCID реестр, по состоянию на 1 августа 2023 г., ORCID больше не получает обновлений базы данных идентификаторов организаций RINGGOLD, используемой нашим реестром, и мы не сможем обрабатывать или использовать идентификаторы RINGGOLD, созданные после этой даты. Посмотрите наш FAQ для дополнительной информации.
Все разделы аффилированности используют один и тот же набор метаданных в API:
- Название организации:* Название организации на высшем уровне (например, «Бостонский университет», а не «Медицинский факультет Бостонского университета»).
- Город организации: * Город, в котором базируется организация.
- Регион организации: Регион, в котором расположена организация.
- Страна организации * страна организации. Это должно быть заполнено двухбуквенный код страны ISO 3166 Alpha-2.
- Идентификатор организации (ROR, GRID, RInggold** или LEI):* Уникальный идентификатор организации и ее источника. Мы рекомендуем использовать идентификатор головной организации в рамках филиала, а не подразделения или отдела.
- Роль / Должность: Занимаемая должность или присвоенная или подлежащая присуждению степень.
- Отдел: Любое подразделение головной организации.
- URL: URL-адрес ресурса о принадлежности
- Дата начала: Дата начала отношений между исследователем и организацией (может быть указана с точностью до года, месяца и дня).
- Дата окончания: Дата окончания отношений между исследователем и организацией (может быть указана с точностью до года, месяца и дня)
- Внешний постоянный идентификатор, описывающий принадлежность: Уникальный идентификатор фактического утверждения о принадлежности
* Обозначает обязательное поле.
**Хотя идентификаторы Ringgold все еще существуют в ORCID реестр, по состоянию на 1 августа 2023 г., ORCID больше не получает обновлений базы данных идентификаторов организаций RINGGOLD, используемой нашим реестром, и мы не сможем обрабатывать или использовать идентификаторы RINGGOLD, созданные после этой даты. Посмотрите наш FAQ для дополнительной информации.
Все разделы аффилированности используют один и тот же набор метаданных в API:
- Название организации:* Название организации на высшем уровне (например, «Бостонский университет», а не «Медицинский факультет Бостонского университета»).
- Город организации: * Город, в котором базируется организация.
- Регион организации: Регион, в котором расположена организация.
- Страна организации * страна организации. Это должно быть заполнено двухбуквенный код страны ISO 3166 Alpha-2.
- Идентификатор организации (ROR, Ringgold**, GRID или LEI):* Уникальный идентификатор организации и ее источника. Мы рекомендуем использовать идентификатор головной организации в рамках филиала, а не подразделения или отдела.
- Роль / Должность: Занимаемая должность или присвоенная или подлежащая присуждению степень.
- Отдел: Любое подразделение головной организации.
- URL: URL-адрес ресурса о принадлежности
- Дата начала: Дата начала отношений между исследователем и организацией (может быть указана с точностью до года, месяца и дня).
- Дата окончания: Дата окончания отношений между исследователем и организацией (может быть указана с точностью до года, месяца и дня)
- Внешний постоянный идентификатор, описывающий принадлежность: Уникальный идентификатор фактического утверждения о принадлежности
* Обозначает обязательное поле.
**Хотя идентификаторы Ringgold все еще существуют в ORCID реестр, по состоянию на 1 августа 2023 г., ORCID больше не получает обновлений базы данных идентификаторов организаций RINGGOLD, используемой нашим реестром, и мы не сможем обрабатывать или использовать идентификаторы RINGGOLD, созданные после этой даты. Посмотрите наш FAQ для дополнительной информации.
An ORCID запись может содержать информацию о работе исследователя, его членстве, финансировании, экспертной оценке и т. д.
Пункты на ORCID записи можно разбить на утверждения которые соединяют ORCID ID-держатель с деятельностью или аффилированностью. Эти утверждения можно добавить в ORCID запись, сделанная исследователем, которому принадлежит запись, или системами, на которые исследователь дал на это разрешение. Мы называем сущность, добавившую утверждение в ORCID записать источник.
Примеры
Следуя нашим принципам прозрачности и открытости, мы считаем, что важно иметь возможность видеть источник утверждения - кто добавляет эту информацию в запись. Вот как мы это делаем:
- Когда исследователь (или его представитель доверенное лицо) добавляет в свою запись утверждение, ORCID автоматически записывает этого человека в качестве источника
- Когда система, одобренная исследователем, добавляет утверждение к записи, ORCID автоматически записывает владельца системы ( ORCID член) в качестве источника.
Мы отображаем имя источника в пользовательском интерфейсе и делаем его доступным (с его уникальным идентификатором) в API:
Однако рабочие процессы исследовательской информации могут быть более сложными, и реальный источник утверждения может быть непреднамеренно скрыт, если одна система добавит элемент от имени человека или другой системы. Чтобы обеспечить прозрачность, нам нужно различать, кто установил связь между человеком и элементом и кто добавил элемент в запись. Как и выше, тот, кто добавляет элемент в ORCID запись - это источник; кто бы ни создавал связь между ORCID iD и товар происхождение утверждения.
Например:
- Исследователь импортирует данные в свои ORCID запись из системы, например мастера поиска и связывания. Исследователь делает утверждение, связывающее их iD с предметом, так что они происхождение утверждения; в то время как система - это объект, добавляющий утверждение к ORCID запись - источник
- Исследователь взаимодействует с Системой А ( утверждение происхождения), который использует услуги, предоставляемые Системой B, для обновления ORCID записей, что делает Систему B источник
Мы призываем наше сообщество принять участие в принятии мер по сохранению и обмену информацией о происхождении утверждений, чтобы каждый мог получить пользу от просмотра источника.
Для получения дополнительной информации, пожалуйста, см.:
Работает в ORCID сгруппированы вместе на основе как их идентификаторов, так и отношения этих идентификаторов к произведению. Существует четыре типа отношений:
- Сам: идентификатор относится исключительно к этой работе и может быть сгруппирован с другими произведениями, имеющими такой же идентификатор.
- Часть: произведение является частью этого идентификатора и не может быть сгруппировано с другими произведениями.
- Версия: эти идентификаторы применяются к альтернативным версиям произведения и могут быть сгруппированы с собственными идентификаторами и версиями.
- Спонсируемый: эти идентификаторы относятся к финансированию работы. Эти идентификаторы не используются для группировки работ.
Наш API обеспечивает поддержку этого в XSD. Каждый элемент имеет атрибут индекса отображения, который указывает его ранг в группе. Самый высокий показатель отображения — это предпочтительный элемент, выбранный исследователем. Элементы, добавленные через API, которые не были оценены исследователем, имеют индекс отображения 1 и используются в качестве предпочтительного источника по умолчанию в группе до тех пор, пока не будут изменены исследователем. Индекс дисплея также определяет порядок работы при чтении ORCID запись с помощью API.
Для получения дополнительной информации о группировке по ORCID записи, пожалуйста, посмотрите наши вспомогательная статья.
ORCID позволяет добавлять несколько видов работ. Ниже приведен список поддерживаемых в настоящее время типов работы, который в значительной степени соответствует стандарту вывода CASRAI.
Публикации
Тип работы | Используйте |
книга | Книги, написанные одним автором или совместно основанные на исследованиях или научных выводах, обычно получаемых за счет финансирования, прошедшего рецензирование. |
глава книги | Тексты, написанные одним автором или совместно основанные на исследованиях или научных открытиях и опыте в определенной области. |
рецензия на книгу | Критический обзор художественных или научно-популярных произведений, подчеркивающий их вклад в искусство, область или дисциплину. |
словарная статья | Записи новых слов, новые значения существующих слов, изменения в написании и расстановке переносов в течение длительного периода времени, а также грамматические изменения. |
диссертация | Трактат, отстаивающий оригинальную точку зрения, полученную в результате исследования: требование для получения докторской степени. Это доступно только с API v2.x |
диссертация | Статья, которая обычно основана на оригинальном исследовании и свидетельствует о мастерстве кандидата как в своем предмете, так и в научном методе. Это доступно только с API версии 3.0+. |
энциклопедия-статья | Автор записей в справочнике или сборнике, посвященном определенной области или всем отраслям знаний. |
отредактированная книга | Книги, редактируемые одним автором или совместно с целью распространения результатов исследований или научных открытий, которые, как правило, являются результатом рецензируемого финансирования. |
Журнальная статья | Статьи в рецензируемых публикациях, распространяющие результаты оригинальных исследований и научных исследований. |
выпуск журнала | Периодические публикации, направленные на стимулирование интеллектуальных дискуссий и исследований. |
статья в журнале | Статьи в тематических изданиях публикуются с определенной периодичностью. |
руководство | Материалы курсов и заданий, разработанные для учебных целей. |
онлайн-ресурс | Информация доступна только в сети традиционными техническими методами. |
информационный бюллетень | Статьи в публикациях, предназначенные для исследователей, лиц, принимающих решения, профессионалов и общественности, которые сообщают об исследовательском проекте или о деятельности исследовательского отделения или исследовательского центра. |
газетная статья | Статьи в ежедневных, еженедельных или ежемесячных публикациях, посвященных новостям и социальным вопросам, нацеленные на общественность. |
препринт | Версия статьи стала общедоступной до официального рецензирования и публикации. Это доступно только с API v3.0 + |
докладу | Отчеты о результатах и результатах исследовательского контракта. |
обзоре | Формальная оценка чужой работы. Это доступно только с API версии 3.0+. |
инструмент исследования | Серия наблюдений, измерений или фактов, выявленных в результате исследования. |
контролируемое студенческое издание | Статьи по результатам исследований, опубликованные совместно с научным руководителем или под его руководством. |
тестXNUMX | Оценки, которые включают тесты, предназначенные для общего выбора университета, отбора на определенные курсы или других целей оценки. |
перевод | Переводы книг и статей, в которых указаны изменения к исходному изданию, такие как новое или пересмотренное предисловие. |
. | Автономные сайты в Интернете, где доступны несколько типов информации по определенной теме. |
рабочий документ | Предварительные версии статей, которые не прошли рецензирование, но могут быть предоставлены для комментариев. |
Конференция
Тип работы | Используйте |
тезисы конференции | Тексты определенной длины, в которых говорится о проблеме, которая будет обсуждаться в предлагаемом документе конференции. |
доклад для конференции | Статьи, написанные самостоятельно или совместно, представленные на научной конференции и опубликованные в трудах (не в научных журналах). |
конференция-афиша | Плакаты, размещенные в обстановке конференции, эффективно передают основные моменты исследований с помощью привлекательной графики. |
Интеллектуальная собственность
Тип работы | Используйте |
раскрытие | Публикации, в которых изобретения считаются предшествующим уровнем техники, тем самым не позволяя другим запатентовать то же изобретение или концепцию. |
лицензия | Подписанные соглашения об использовании части ИС, например процесса, продукта, данных или программного обеспечения. |
патент | Форма защиты интеллектуальной собственности, которая определяет исключительное право по закону для изобретателей и правопреемников использовать и эксплуатировать свои изобретения, продукты или процессы в течение ограниченного периода времени. |
зарегистрированное авторское право | Зарегистрированное владение правами в соответствии с системой законов для поощрения создания и доступа к художественным, литературным, музыкальным, драматическим и другим творческим произведениям. |
товарный знак | Такие знаки, как имя, слово, фраза, логотип, символ, дизайн, изображение продукта или услуги, которые указывают на источник и предоставляют право контролировать использование идентификатора. |
Другое
Тип работы | Используйте |
аннотирование | Аннотации содержат комментарии или описания другого ресурса. Это доступно только с API v3.0 + |
артистический перформанс | Сбор информационных записей, которые в совокупности представляют собой полную и актуальную историю творческих или исполнительских работ, являющихся результатом исследований или научной деятельности человека или связанных с ними. |
план управления данными | Официальное заявление, описывающее, как данные исследования будут обрабатываться и документироваться в ходе исследовательского проекта, а также условия, касающиеся последующего депонирования данных в хранилище данных для долгосрочного управления и сохранения. Это доступно только с API v3.0 + |
набор данных | Серия структурированных наблюдений, измерений или фактов, выявленных в результате исследования, которые могут быть сохранены на носителе базы данных. |
изобретение | Практические и оригинальные результаты исследований. |
лекция-выступление | Информативный доклад, посвященный исследованию, представленному аудитории. |
физический объект | Образец, образец или другой физический объект, используемый в исследовательских целях; неодушевленный трехмерный объект или вещество. Это доступно только с API v3.0 + |
техника исследования | Практические методы или навыки, применяемые для решения конкретных задач, определенных в рамках исследования. |
программное обеспечение | Программа, используемая для управления компьютером или другим техническим устройством. |
дочерняя компания | Компания, созданная исследовательской организацией для коммерческого использования результатов и выводов исследовательского проекта. |
стандарты и политика | Разработка правила или принципа, которые используются в качестве основы для суждения. |
технический стандарт | Технические стандарты (промышленные или иные), которые возникли в результате исследовательских проектов, в которых могут быть разработаны новые протоколы, методы или материалы. |
другие | Любой другой вид работы. |
Пожалуйста, ознакомьтесь с нашим список поддерживаемых идентификаторов для API V3.0. Время от времени мы добавляем новые типы по запросу ORCID участники, которые хотели бы использовать их при добавлении элементов в реестр.
ORCID поддерживает использование Идентификаторы ROR, Идентификаторы GRID и Реестр Crossref Funder идентификаторы для устранения неоднозначности организаций в ORCID Records.
Для получения дополнительной информации см. Работа с идентификаторами организации
Хотя идентификаторы Ринггольда все еще существуют в ORCID реестр, по состоянию на 1 августа 2023 г., ORCID больше не получает обновлений базы данных идентификаторов организаций RINGGOLD, используемой нашим реестром, и мы не сможем обрабатывать или использовать идентификаторы RINGGOLD, созданные после этой даты. Посмотрите наш FAQ для получения дополнительной информации
Мы ввели новое поле, генерируемое системой, которое выражает внешние идентификаторы (DOI, PMCID, PMID, ArXiv, Bibcode, ISSN и ISBN) в нормализованном формате для целей сопоставления и группировки. Нормализация выполняется на основе правил типа идентификатора и может включать в себя установку всех буквенных символов в нижний регистр или преобразование пробелов, тире, точек и других символов, которые можно рассматривать как эквивалентные. При необходимости он также добавляет стандартные префиксы и суффиксы. Например, https://doi.org/10.1/123, 10.1/123и https://dx.doi.org/10.1/123 все появятся в этом поле как https://doi.org/10.1/123. Существующее значение идентификатора не изменяется.
- Во-первых,
- дополнительный
Роли для Works API 2.0
Ниже приведен список поддерживаемых ролей участников с использованием API 2.0.- автор
- правопреемник
- редактор
- стул или переводчик
- соисследователь
- соавтор
- аспирант
- другой изобретатель
- главный следователь
- докторант-исследователь
- вспомогательный персонал
Роли для Works API 3.0
С API 3.0 вы можете добавить роли, указанные выше, а также дополнительные роли CRedIT. Таксономия CRediT состоит из 14 видов вклада в научную работу, вместе с рекомендациями о том, как могут быть назначены эти роли. Ниже приведен полный список со значением пользовательского интерфейса и значением метаданных. Значением метаданных является URL-адрес в соответствии с рекомендациями по реализации NISO.CRediT должен быть закодирован в JATS xml v1.2, описанном по этой ссылке: https://jats4r.org/credit-taxonomy.' При добавлении ролей через API будет принят только URL-адрес.Пример метаданных участника работы:
https://orcid.org/0000-0001-5109-3700 0000-0001-5109-3700 orcid.org Laure L. Haak first author
Роли для финансирования
- вести
- соруководитель
- поддерживается
- другой вклад
ORCID предоставляет свободное текстовое поле для цитирования, чтобы исследователи могли легко вводить информацию в текстовом формате. Тем не менее, мы настоятельно рекомендуем всем пользователям API добавлять ссылки в BibTeX, который доступен для машинного чтения. Почтенный формат, несмотря на то, что он появился раньше Интернета, может быть преобразован в желаемый формат с помощью интеграций и авторов. Он поддерживается большинством справочных менеджеров и издательских платформ.
Подробнее о BibTeX см. https://www.bibtex.org.
Любой автор, издатель которого использует Crossref для регистрации DOI, может получить выгоду от интеграции автоматического обновления Crossref.
Издателям необходимо включить аутентифицированные ORCID идентификаторы авторов в метаданных, отправленных в Crossref при регистрации DOI.
Затем Crossref запросит разрешение у автора, отправив уведомление на его адрес. ORCID входящие, чтобы обновить их ORCID запись с этой публикацией и любыми новыми публикациями от любого издателя.
Для получения дополнительной информации см .: https://www.crossref.org/community/orcid/
Каждый элемент в ORCID iD присваивается код пут, который однозначно идентифицирует его. При чтении всей записи или раздела код размещения можно найти как атрибут элемента. Когда вызов определенного элемента в записи, код ввода используется для идентификации товара. Коды пут уникальны в пределах того типа элемента, к которому они относятся. Используя этот пример, только одна работа в ORCID В реестре будет код размещения 733535, хотя 733535 также может использоваться в качестве кода размещения для элемента финансирования или ключевого слова.
В пользу ORCID членство, организации могут спросить ORCID для поддержки дополнительных типов PID в ORCID Реестр. Например, участник может запросить, чтобы мы добавили поддержку PID, которые они используют для идентификации образцов или наборов данных в их геологической базе данных. Это обеспечивает связь между образцами и людьми, которые их собирали. И поскольку все новые типы PID, которые мы добавляем, должны быть, по крайней мере, разрешимыми, а желательно FAIR, эти ссылки являются однозначными, устойчивыми во времени и действенными, что приносит пользу исследователю, членской организации и более широкому сообществу.
Добавление вашего PID!
Как общественная организация, мы хотим, чтобы ORCID поддерживает PID, используемые нашими участниками. Мы поддерживаем полный список существующих идентификаторов, поддерживаемых в реестре и пригласить ORCID члены использовать эта форма для запроса дополнительных PID. Мы стремимся ответить на ваш запрос как можно скорее.
ORCID имеет отдельный раздел в ORCID запись для записи информации о квалификации, аккредитации, сертификатах и значках.
Каждый квалификационный элемент всегда будет содержать:
- Квалификационное звание
- Идентификатор организации поставщика (например, идентификатор ROR)
- Дата добавления в ORCID запись
- Кто добавил квалификацию (источник)
Они могут содержать:
- Дата действия, включая дату окончания, если срок действия квалификации истекает.
- Постоянный идентификатор квалификации, определяющий тип полученной квалификации.
- URL-адрес квалификации, который содержит удобочитаемое описание типа полученной квалификации.
- Постоянный идентификатор квалификации. Он должен ссылаться на онлайн-версию сертификата квалификации. Это может быть существующий уникальный идентификатор или просто URI.
Аутентификация и OAuth
Любой человек с общедоступными учетными данными или учетными данными API может получить / read-public токен доступа. Чтобы получить токен, вы звоните в ORCID Конечная точка токена API.
Этот процесс часто называют потоком OAuth для учетных данных клиента или двухэтапным OAuth.
Пример вызова для получения токена доступа для чтения общедоступных данных в песочнице - замените заполнители своими учетными данными (обязательно удалите скобки.
URL=https://sandbox.orcid.org/oauth/token
HEADER: Accept: application/json
METHOD: POST
DATA:
client_id=[Your public API client ID]
client_secret=[Your public API secret]
grant_type=client_credentials
scope=/read-public
Затем вам будет возвращен токен доступа, подобный приведенному ниже. Возвращенный токен является долгоживущим (не истекает примерно 20 лет) и может использоваться несколько раз для получения общедоступных данных из ORCID Records.
{"access_token":"4bed1e13-7792-4129-9f07-aaf7b88ba88f","token_type":"bearer",
"refresh_token":"2d76d8d0-6fd6-426b-a017-61e0ceda0ad2","expires_in":631138518,
"scope":"/read-public","orcid":null}
Примечание: Все токены с областью / Authenticate теперь также имеют область / read-public. Если вы используете только область / Authenticate, вы можете использовать сохраненные токены доступа для чтения общедоступных данных без необходимости повторного получения токена доступа.
Интеграторы, использующие членский API, могут использовать / read-public возможности для чтения ORCID записывать конспекты.
Чтобы получить / ограниченный доступ для чтения, вы должны спросить разрешения у исследователя. Вы делаете это с помощью OAuth. Конкретно, "Трехсторонний OAuth».
Для получения дополнительной информации, пожалуйста, посетите наш Учебное пособие по API: чтение данных на ORCID запись
ORCID интеграции используют «трехсторонний протокол OAuth» для аутентификации пользователей и запроса разрешения на взаимодействие с их записями. Любая интеграция может запрашивать разрешения на чтение с помощью общедоступного API. ORCID участники могут использовать API участников, чтобы запросить разрешения на обновление. Это работает следующим образом:
- Вы создаете специальную ссылку
- При нажатии пользователь отправляется на ORCID
- ORCID просит пользователя войти в систему
- ORCID просит пользователя предоставить разрешение вашему приложению
- ORCID отправляет пользователя обратно в вашу систему с кодом авторизации
- Ваша система обменивает этот код на токен доступа
Настраиваемый URL-адрес авторизации включает в себя информацию о вашем клиенте, а также «области», определяющие конкретные области их записей, к которым вы хотите получить доступ. После входа в систему пользователь авторизует соединение с вашей системой и возвращается на целевую страницу вместе с кодом авторизации. Этот код затем используется для получения их ORCID iD вместе с токеном доступа, действительным для запрошенных областей.
Вы создаете ссылку авторизации, указывая идентификатор клиента учетных данных API и связанную целевую страницу (URI перенаправления). Вы выбираете, какие разрешения запрашивать, устанавливая параметр области.
В приведенном ниже примере запрашивается разрешение на чтение данных с ограниченным доступом на ORCID сервер тестирования в песочнице. В реальном мире вы отображаете эту ссылку на своем веб-сайте или включаете ее в электронное письмо, когда просите пользователя пройти аутентификацию и авторизацию. Однако в целях тестирования вы можете просто вставить его в свой веб-браузер. Замените данные в квадратных скобках информацией о вашем клиенте и обязательно удалите квадратные скобки!
https://sandbox.orcid.org/oauth/authorize?client_id=[Your client ID]&response_type=code&scope=/read-limited&redirect_uri=[Your landing page]
После того, как пользователь щелкнул ссылку, вошел в систему на ORCID и предоставленные разрешения они перенаправляются обратно на ваш сайт, например:
https://[Your landing page]?code=Q70Y3A
Вам следует немедленно обменять код авторизации на ORCID iD и токен доступа. Срок действия кода авторизации истекает после его использования. Запрос выглядит так и нельзя сделать в веб-браузере, это должен сделать ваш сервер.
URL=https://sandbox.orcid.org/oauth/token
HEADER: Accept: application/json
HEADER: Content-Type: application/x-www-form-urlencoded
METHOD: POST
DATA:
client_id=[Your client ID]
client_secret=[Your client secret]
grant_type=authorization_code
code=Six-digit code
redirect_uri=[Your landing page]
ORCID затем вернет проверенные исследователем ORCID iD и токен доступа в формате JSON:
{"access_token":"f5af9f51-07e6-4332-8f1a-c0c11c1e3728","token_type":"bearer",
"refresh_token":"f725f747-3a65-49f6-a231-3e8944ce464d","expires_in":631138518,
"scope":"/read-limited","name":"Sofia Garcia","orcid":"0000-0001-2345-6789"}
По умолчанию токены доступа имеют долгий срок действия и истекают через 20 лет после выпуска. Токен можно использовать несколько раз до истечения срока его действия.
Используйте токен доступа
Токены трехстороннего доступа связаны с конкретными ORCID записывать. Чтобы использовать их, вы включаете их в запросы API, которые вы делаете для чтения или обновления этой записи.
При запросе разрешения на взаимодействие с ORCID запись пользователя, вы указываете одну или несколько «областей». Каждая область позволяет вам делать определенные вещи, например, читать запись или обновлять определенный раздел.
3 ножка относится к трем участникам, участвующим в получении разрешения от пользователя; ORCID, ваша система и сам пользователь.
/ аутентифицировать
Этот объем используется для сбора ORCID iD и читать общедоступную информацию только в записи. Все остальные трехсторонние области включают разрешение проверки подлинности, поэтому эту область можно не указывать при запросе любого другого доступа. Эта область доступна в членском или общедоступном API.
/ read-limited (только для API участников)
Эта область используется для получения доступа к общедоступным элементам и элементам с ограниченной видимостью на ORCID записывать. Эта область доступна только в API участников.
/ activity / update (только для API участников)
Эта область используется для записи, обновления и удаления элементов в разделах «Аффилиация», «Финансирование», «Работы», «Профессиональная деятельность», «Исследовательские ресурсы» и «Рецензирование». ORCID записывать. Эта область доступна только в API участников.
/ person / update (только для API участников)
Эта область используется для записи, обновления и удаления элементов в разделах записи, посвященных другим именам, ключевым словам, странам, URL-адресам исследователей, веб-сайтам и личным внешним идентификаторам. Эта область доступна только в API участников.
OpenID
Эта область используется интеграторами OpenID, когда требуется id_token. Когда область openid включена, реестр вернет id_token внутри ответа токена и предоставит клиенту разрешение на доступ к конечной точке информации о пользователе для этого пользователя. Эта область доступна в общедоступном и членском API.
Обратите внимание, что область «openid» не начинается с символа «/», как другие. ORCID Области API. Это связано с тем, что область действия openid не определяется ORCID, но вместо этого определяется спецификацией OpenID Connect. Пожалуйста, посмотрите наш Документация OpenID чтобы получить больше информации.
Несколько областей
За одно взаимодействие можно запросить несколько областей, перечислив области в URL-адресе аутентификации с закодированным пространством между ними, например scope = / read-limited% 20 / activity / update% 20 / person / update.
Полный доступ
Если вам нужен полный доступ для чтения и редактирования записи, включите в свой URL аутентификации три области: / read-limited, / activity / update и / person / update. В URL-адресе они будут отображаться как scope = / read-limited% 20 / activity / update% 20 / person / update.
Двухсторонние (учетные данные клиента) области
Для некоторых действий вам не нужно спрашивать разрешения у пользователя. Две области действия OAuth запрашиваются непосредственно из ORCID API и не требуют разрешения исследователя. Токены с такими областями действия действительны в течение 20 лет и могут быть использованы повторно.
/ read-public
Эта область используется для чтения общедоступной информации на одном ORCID ID, найти ORCID записи или для чтения сводной информации (только API-члены). Эта область доступна в членском или общедоступном API.
/ webhook
Эта область позволяет клиентскому приложению регистрировать веб-перехватчик на ORCID запись, чтобы получать уведомления при обновлении записи. Этот прицел доступен для премиум-класса. ORCID только для членов.
Если вас беспокоит, что несколько пользователей находятся на одном компьютере и не выходят из системы между сеансами, вы можете заставить их повторно пройти аутентификацию во время процесса OAuth. Просто включите prompt=login
в запросе OAuth. Вы также можете установить max_age в секундах, чтобы заставить пользователей повторно аутентифицироваться, если их сеанс превышает определенную длину. Смотрите наши Документация OpenID Connect Больше подробностей.
Пользователи могут в любой момент самостоятельно изменить язык отображения. Доступны следующие языковые настройки:
Язык | 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 |
Могут использоваться любые или все параметры:
Параметр | Поиск | Заметки |
второе имя | Собственное имя | Команда имя поле будет заполнено на регистрационный формуляр если указанный адрес электронной почты или 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
Если активный токен доступа уже существует с теми же областями, которые запрашивает ваш URL-адрес авторизации OAuth, и пользователь вошел в свою ORCID записи, им не будет предложено повторно предоставить авторизацию. Вместо этого они будут перенаправлены непосредственно на URI перенаправления. Если вы хотите требовать от пользователя предоставления авторизации при каждом подключении, используйте метод принудительного выхода
Неявный OAuth — это облегченная версия OAuth, предназначенная для использования системами, которые не имеют или не хотят использовать серверные компоненты. Неявный OAuth может быть полностью реализован в браузере с использованием только JavaScript. Он доступен для членов и нечленов и работает следующим образом:
- Вы создаете специальную ссылку
- При нажатии пользователь отправляется на ORCID
- ORCID просит пользователя подписать i
- ORCID просит пользователя предоставить разрешение вашему приложению
- ORCID отправляет пользователя обратно в вашу систему с его ORCID iD, токен доступа и идентификационный токен.
- Ваша система извлекает и хранит аутентифицированные ORCID iD из ответа.
В целях безопасности при использовании неявного OAuth ORCID не будет возвращать токены доступа с разрешениями на обновление.
Неявный поток
Неявный поток разработан таким образом, что клиентам не нужно использовать свой секретный ключ для запуска ORCID войдите в систему. Безопасность обеспечивается ограничением клиентов их зарегистрированными redirect_urls. Этот более низкий уровень безопасности означает, что ORCID поддерживает только области / Authenticate и openid при использовании неявного потока. Токены также недолговечны, их продолжительность жизни составляет 10 минут. Этот поток рекомендуется для клиентских приложений, у которых нет доступа к внутреннему серверу, например, телефонных приложений или одностраничных веб-приложений javascript.
https://localhost/#access_token=24c11342-f5da-4cf9-94a4-f8a72a30da00&token_type=bearer&expires_in=599&tokenVersion=1&persistent=false&id_token=eyJraWQiOiJxYS1vcmNpZC1vcmctcjlhZmw3cWY2aG2c5bmdzenU1bnQ3Z3pmMGVhNmkiLCJhbGciOiJSUzI1NiJ9.eyJhdF9oYXNoIjoiMW52bXZBbVdwaVd0Z3ZKZW1DQmVYUSIsImF1ZCI6IkFQUC02TEtJSjNJNUIxQzRZSVFQIiwic3ViIjoiMDAwMC0wMDAyLTUwNjItMjIwOSIsImF1dGhfdGltZSI6MTUwNTk4Nzg2MiwiaXNzIjoiaHR0cHM6XC9cL29yY2lkLm9yZyIsIm5hbWUiOiJNciBDcmVkaXQgTmFtZSIsImV4cCI6MTUwNTk4ODQ2MywiZ2l2ZW5fbmFtZSI6IlRvbSIsImlhdCI6MTUwNTk4Nzg2Mywibm9uY2UiOiJ3aGF0ZXZlciIsImZhbWlseV9uYW1lIjoiRGVtIiwianRpIjoiY2U0YzlmNWUtNTBkNC00ZjhiLTliYzItMmViMTI0ZDVkNmNhIn0.hhhts2-4-ibjXPW6wEsFRaNqV_A-vTz2JFloYn7mS1jzQt3xuHiSaSIiXg3rpnt1RojF_yhcvE9Xe4SOtYimxxVycpjcm8yT_-7lUSrc46UCt9qW6gV7L7KQyKDjNl23wVwIifpRD2JSnx6WbuC0GhAxB5-2ynj6EbeEEcYjAy2tNwG-wcVlnfJLyddYDe8AI_RFhq7HrY4OByA91hiYvHzZ8VzoRW1s4CTCFurA7DoyQfCbeSxdfBuDQbjAzXuZB5-jD1k3WnjqVHrof1LHEPTFV4GQV-pDRmkUwspsPYxsJyKpKWSG_ONk57E_Ba--RqEcE1ZNNDUYHXAtiRnM3w
Смотрите наши техническая документация чтобы получить больше информации.
Что такое URI перенаправления и как они используются?
URI перенаправления используются нашей службой аутентификации OAuth в качестве меры безопасности. ORCID будет отправлять аутентифицирующихся пользователей только на URI, зарегистрированные клиентом, запрашивающим аутентификацию. Это предотвращает олицетворение служб друг другом.
Обратите внимание, что только URI HTTPS принимаются в производство. Вы можете протестировать использование HTTP URI, но вам нужно будет зарегистрироваться URI HTTPS когда вы подаете заявку на получение учетных данных API-члена рабочей среды.
Как мы сопоставляем URI перенаправления?
- Вы ДОЛЖНЫ зарегистрировать поддомены как отдельные URI.. https://anythingelse. ThirdParty.com не будет работать.
- Полная регистрация всех URI перенаправления, включая путь, рекомендуется, это то, что делают большинство третьих сторон, и это самый безопасный вариант.
- Если клиентское приложение зарегистрировано с URI перенаправления, который является просто именем хоста, то можно использовать любой URI перенаправления на этом хосте.. Так, например, если зарегистрирован следующий URI перенаправления: https://thirdparty.com тогда все следующие redirect_uris будут работать:
- https://thirdparty.com/oauth/callback1
- https://thirdparty.com/callback2
- https://thirdparty.com/anything-else-as-long-as-the-host-is-the-same
Однако https://anythingelse. ThirdParty.com не будет работать. ОБЯЗАТЕЛЬНО зарегистрировать поддомены как отдельные URI.
Что произойдет, если мой URI перенаправления неверен?
Пользователи отправлены для аутентификации в ORCID с неправильными URI перенаправления увидит сообщение об ошибке, подобное этому:
Управление URI перенаправления для участников
Если вы используете членский API и вам требуются какие-либо изменения в ваших URI перенаправления, обратитесь в нашу группу взаимодействия.
Управление URI перенаправления для общедоступных клиентов
Если вы используете общедоступный API, вам нужно будет выполнить следующие шаги, чтобы обновить список URI перенаправления, связанных с вашим ORCID общедоступный идентификатор клиента API. Вы можете сделать это, выполнив следующие действия:
- Войдите в свой ORCID запись
- Щелкните свое имя в правом углу
- Выберите инструменты разработчика
- Щелкните карандаш редактирования рядом с именем клиента.
- Отредактируйте существующий URI перенаправления или нажмите «Добавить другой URI перенаправления», отредактируйте существующий
- После того, как вы внесли изменения, вам нужно нажать на значок сохранения
Только URI HTTPS принимаются в производство. Вы можете протестировать использование http URI, но вам нужно будет зарегистрировать HTTPS URI при подаче заявки на учетные данные API-члена рабочей среды.
OpenID Connect 1.0 - это простой уровень идентификации поверх протокола OAuth 2.0. Он дополняет существующие потоки аутентификации OAuth и предоставляет клиентам информацию о пользователях в хорошо описанной форме.
OpenID connect - это стандартизированный способ реализации OAuth и обмена информацией об аутентифицированных пользователях. Теперь можно будет настроить службы для использования ORCID «из коробки» наряду с другими провайдерами OpenID Connect, соответствующими стандартам. OpenID Connect также предоставляет токены ID с возможностью совместного использования, которые являются подписанными объектами, которые могут подтвердить, что пользователь прошел аутентификацию с помощью ORCID в определенное время. Эти токены могут использоваться элементами пользовательского интерфейса для поддержки пользовательских сеансов.
ORCID поддерживает базовый профиль соответствия поставщика OpenID, который является расширением потока кода авторизации OAuth. ORCID также поддерживает неявный поток токенов для областей действия «/ authenticate» и «openid».
Это означает, что ORCID:
- Встраивает подписанные токены идентификаторов в ответы токенов для кодов авторизации, сгенерированных с областью действия «openid»
- Поддерживает неявный поток при использовании response_types 'token' или 'token id_token' и области 'openid'.
- Поддерживает параметры «prompt», «nonce» и «max_age» для запросов авторизации, которые включают область «openid».
- Поддерживает обнаружение Openid Connect и конечные точки информации пользователя
- Поддерживает поле amr для интеграторов, использующих членский API для запросов авторизации, которые включают область openid. Это можно использовать, чтобы определить, прошел ли пользователь аутентификацию с использованием двухфакторной аутентификации.
Инициирование аутентификации OpenID Connect работает так же, как обычная аутентификация OAuth. Все, что требуется, это то, что клиент запрашивает область «openid». Если вы используете область / Authenticate, замените ее на openid, поскольку Authenticate и openid имеют одинаковую авторизацию, следует использовать только один или другой. Если вы используете какие-либо другие области, добавьте openid в список запрашиваемых областей. Когда область openid включена, реестр вернет id_token внутри ответа токена и предоставит клиенту разрешение на доступ к конечной точке информации о пользователе для этого пользователя.
обратите внимание, что область «openid» не начинается с «/», как другая ORCID Области API. Это связано с тем, что область действия openid не определяется ORCID, но вместо этого определяется спецификацией OpenID Connect.
Смотрите наши техническая документация чтобы получить больше информации.
ORCID позволяет пользователям включать Двухфакторная аутентификация (2FA) на их ORCID учетная запись. 2FA - это дополнительная проверка безопасности, выполняемая во время входа в систему. Он обеспечивает дополнительное подтверждение того, что пользователь действительно является лицом, входящим в ORCID учетная запись. Для получения дополнительной информации о том, как это можно настроить для пользователей, см. Наш Статья в KB.
OpenID интеграторы, использующие членский API, могут проверить, вошел ли пользователь в их ORCID аккаунт с включенной двухфакторной аутентификацией в рамках процесса OAuth. Это может позволить интеграторам-членам предоставлять своим исследователям доступ к системам с более высоким уровнем безопасности.
В соответствии с наша приверженность исследователю контролировать их ORCID запись, владелец записи может в любой момент отозвать любой токен доступа, удалив его из разрешений в Доверенная организацияn список на странице их доверенных лиц.
С 2018 года исследователи могут предоставлять только долговечные токены доступа, срок действия которых составляет 20 лет, если пользователь не отменит разрешение.
ORCID обеспечивает простой Виджет Java Script которые можно использовать для получения аутентифицированных ORCID iD, использующие OAuth с OpenID Connect.
Обратите внимание, что виджет использует неявный протокол OAuth, поэтому не собирает никаких разрешений на запись. Это означает, что он не подходит для интеграции участников, которые хотят обновлять записи. Пожалуйста, посмотрите наш учебник для Добавление и обновление данных на ORCID Records.
ORCID API
Учетные данные открытого клиента предоставляются отдельным лицам, а не организациям. Учетные данные нельзя передавать от одного человека к другому, но их можно преобразовать в учетные данные члена API, если согласие получено от всех сторон и организация является активным членом ORCID.
Перемещение идентификатора клиента в API участника не изменит идентификатор клиента, изменится только секрет клиента, и вы сохраните количество подключенных идентификаторов с разрешением только на чтение.
При преобразовании клиента Public API в клиент Member API Условия обслуживания публичных клиентов больше не применяются, и их заменяют условия членского соглашения.
Для переноса нам понадобится:
- Подтверждение идентификатора клиента Public API, который будет преобразован.
- Основное контактное лицо организации и держатель записи текущего идентификатора клиента Public API согласны с изменением Условий обслуживания. (Держатель записи должен быть сотрудником, подрядчиком или должностным лицом организации-члена). Мы будем вести учет согласия обеих сторон.
- Дата/время для миграции. В рамках этой миграции мы обновим идентификатор клиента и отправим вам новый секрет клиента в зашифрованном электронном письме. Обратите внимание, что после обновления клиента ваша интеграция не будет работать, пока вы не обновите секрет клиента. Вот почему нам нужно зафиксировать дату и время для этого и предотвратить неудобства для пользователей.
Чтобы преобразование было завершено, вам необходимо обновить:
- Старый секрет клиента в новый секрет клиента.
- Хост API из pub.orcid.org в api.orcid.org.
С преобразованным идентификатором клиента Member API вы можете обновить области, чтобы добавить области API-членов. Для этого потребуется авторизация пользователей, и будут созданы новые токены доступа, включающие новые области/разрешения.
Обратите внимание, что мы не можем преобразовать учетные данные клиентов Member API в учетные данные Public API.
Этот пример вызова извлекает сводку полного ORCID запись в формате XML с использованием членского API на сервере песочницы. Вам нужен токен доступа, чтобы делать запросы API к общедоступному или членскому API.
Method: GET
Accept: application/vnd.orcid+xml
Authorization type and Access token: Bearer [Stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/record
API вернет сообщение 200 OK, указывающее, что запрос был успешно получен, и полный обзор ORCID запись, включая краткое изложение отдельных элементов
<?xml version="1.0" encoding-"UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789"
xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">
[...]
</record:record>
Каждый элемент (работа, финансирование, занятость и т. Д.) Имеет поставить код. При необходимости его можно использовать для получения полной информации об элементе.
Команда ORCID Запись разделена на отдельные разделы, чтобы сделать чтение записи более быстрым и последовательным. Вы можете сначала вызвать раздел, чтобы получить его сводку, а затем вызвать, используя код размещения отдельного элемента, чтобы получить надежную информацию об этом элементе.
Таблица сводных разделов, для чтения которых вы можете использовать API, приведена ниже.
Конечная точка | Описание |
/записывать | Сводный вид полного ORCID запись |
/человек | Биографический раздел ORCID запись, в том числе URL-адреса / исследователя ниже |
/резюме | Сводное представление проверенных и самозаявленных элементов на ORCID запись (доступна только с API-членом) |
/адрес | Страны или регионы исследователя |
/электронное письмо | Адрес (а) электронной почты, связанный с записью |
/ внешние идентификаторы | Связанные внешние идентификаторы в других системах |
/ ключевые слова | Ключевые слова, связанные с исследователем и его работой |
/Другие названия | Другие имена, под которыми известен исследователь |
/личные данные | Личные данные: имя исследователя, кредитное (опубликованное) имя и биография. |
/ исследователь-urls | Ссылки на личные или профильные страницы исследователя |
/виды деятельности | Краткое изложение раздела мероприятий ORCID запись, в том числе через / работает ниже. |
/ образование | Принадлежность к образованию |
/ вакансии | Принадлежность к трудоустройству |
/ финансирование | Резюме финансовой деятельности |
/ peer-reviews | Резюме деятельности по экспертной оценке |
/работает | Резюме исследовательских работ |
/ исследования-ресурсы | Резюме исследовательских ресурсов |
/Сервисы | Краткое описание услуг |
/ квалификация | Резюме квалификаций |
/ членство | Резюме членства |
/ различия | Резюме различий |
/ приглашенные должности | Резюме приглашенных должностей |
Элементы (работы, трудоустройство, финансирование, экспертная оценка и т. Д.) Могут быть добавлены в ORCID запись вручную или с помощью ORCID членский API. Если вы частное лицо и хотите обновить свою запись, посетите наш раздел помощи по этому поводу здесь. Если вы являетесь участником и хотите добавить элементы в ORCID записи, вам понадобится следующее:
- Разрешение исследователей
- Учетные данные API участника
- И либо:
- Система поставщика, которая интегрируется с ORCID Членский API
- Ваша собственная система, которая интегрируется с ORCID Членский API
Полное руководство для участников, использующих API для записи элементов, можно найти по ссылке на наше руководство по API ниже:
Этот пример вызова извлекает сводку полного ORCID запись в формате XML с использованием членского API на сервере песочницы. Вам нужен токен доступа, чтобы делать запросы API к общедоступному или членскому API.
Method: GET Accept: application/vnd.orcid+xml
Authorization type and Access token:
Bearer [Stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/record
API вернет сообщение 200 OK, указывающее, что запрос был успешно получен, и полный обзор ORCID записи, включая сводки по отдельным пунктам.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">
[...]
</record:record>
Каждый элемент (работа, финансирование, занятость и т. Д.) Имеет поставить код. При необходимости его можно использовать для получения полной информации об элементе.
Для поддержки социальной составляющей мы предлагаем инструментарий Информационные ресурсы чтобы помочь вам разработать кампанию в поддержку вашей интеграции и сообщить вашим исследователям:
- Что ORCID есть.
- Почему ваша система собирает iD и как ваша система будет выполнять задачи, например обновлять их записи.
- Почему ваши исследователи выиграют от создания ORCID iD и подключить их iD к вашей системе.
- Как ORCID приносит пользу более широкому глобальному исследовательскому сообществу.
Мы будем постоянно создавать эту «библиотеку» ресурсов на основе отзывов сообщества. Если у вас есть идея, что вы хотели бы увидеть, пожалуйста, свяжитесь с нами.
Прежде чем вы сможете добавить элемент в ORCID запись, вам нужно будет отформатировать ваши данные в ORCID схема. Отформатируйте данные в ORCID схема сообщения в XML или JSON.
Наш репозиторий GitHub содержит ресурсы, которые помогут с форматированием при создании новых элементов на ORCID записи, а при чтении существующих элементов на ORCID запись:
обратите внимание, что разные версии API имеют разные форматы сообщений. Также доступны схемы и примеры версий 2.0 и 2.1..
Дополнительные примеры можно легко найти, прочитав метаданные хорошо заполненной записи.
Более ранняя версия ORCID У API были дополнительные области применения. Эти области были прекращены с использованием API 2.0. Мы рекомендуем при любой интеграции использовать только рекомендуемые области. Для справки, более ранние области перечислены ниже с текущей областью, которую следует использовать вместо
- /orcid-profile/чтение-ограничено использовать вместо / read-limited
- /orcid-works/read-limited использовать вместо / read-limited
- /orcid-bio/read-limiteбуду использовать вместо / read-limited
- /orcid-works/создать использовать вместо / действия / обновление
- /orcid-works/обновление использовать вместо / действия / обновление
- / affiliations / create использовать вместо / действия / обновление
- / affiliations / update использовать вместо / действия / обновление
- / финансирование / создать использовать вместо / действия / обновление
- / financial / update используйте вместо / activity / update
- /orcid-био/обновление использовать вместо / человек / обновление
- /orcid-bio/внешние-идентификаторы/создать использовать вместо / человек / обновление
Токены обновления используются для создания дополнительных токенов доступа. Токен обновления возвращается с токеном доступа при обмене кодом авторизации как часть трехсторонние процессы OAuth, и его можно использовать, пока токен доступа остается активным.
Новые токены доступа могут иметь тот же срок действия и области действия, что и исходный токен доступа, или могут иметь более короткий срок действия, а также меньшее подмножество областей действия по сравнению с исходным токеном доступа. Новые токены доступа могут быть сгенерированы для замены исходного токена или созданы для использования в качестве дополнительного токена. Вы также можете использовать вызовы токенов обновления для полного истечения срока действия исходного доступа и токенов обновления и любых разрешений, предоставленных пользователем.
Мы предлагаем использовать токены обновления в следующих случаях:
- Замена токенов доступа, которые могли быть скомпрометированы (не забудьте отозвать исходный токен доступа после)
- Предоставление третьей стороне, которая также является частью вашего ORCID интеграция более ограниченный доступ и / или доступ на ограниченное время.
Пожалуйста, обратитесь к нашим техническая документация о том, как создавать новые токены доступа из токенов обновления.
Существует два разных объема обновлений: один для биографических данных, а другой - для мероприятий.
Объем | Описание | Конечные точки API |
/ человек / обновление | Биографические данные — левая колонка ORCID запись пользовательского интерфейса. | /адрес / внешние идентификаторы / ключевые слова /Другие названия / исследователь-urls |
/ действия / обновление | Данные об исследовательской деятельности — правая колонка ORCID запись пользовательского интерфейса. | /различие / различия /образование / образование /работа / вакансии / финансирование / финансирование / приглашенная позиция / приглашенные должности / членство / членство / peer-review / peer-reviews /квалификация / квалификация / research-ресурс / исследования-ресурсы /служба /Сервисы /Работа /работает |
Используйте свой идентификатор клиента, секрет и либо активный токен, либо связанный с ним токен обновления, чтобы отозвать пару токенов. Вы можете отозвать пары токенов, созданные как в двуногом, так и в трехсторонние процессы OAuth. Если у вас есть несколько наборов токенов, например, для разных областей, только указанный токен доступа и соответствующий токен обновления будут отозваны.
Мы предлагаем отозвать токены в следующих случаях:
- Отозвать токены, выданные стороннему поставщику после прекращения отношений;
- Чтобы отозвать токены, когда пользователи отключают свои ORCID iD из вашей системы;
- Чтобы пользователи могли отзывать токены из вашей системы.
Мы рекомендуем использовать обновить токены для ограничения области действия или продолжительности существующего токена доступа или обновления токена, если он был скомпрометирован.
Отзыв вызова API
https://sandbox.orcid.org/oauth/revoke (or https://orcid.org/oauth/revoke)
METHOD: POST
HEADER: accept:application/json
CONTENT-TYPE: application/x-www-form-urlencoded
DATA:
client_id=[Your client ID]
client_secret=[Your client secret]
token=[access token or refresh token for token pair to be revoked]
Все предметы (кроме текста биографии) на ORCID запись есть поставить код:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0"> [...]
</record:record>
Этот код размещения можно использовать для вызова API для получения полных данных для элемента. Следующие элементы можно запросить с помощью поставить код:
Конечная точка | Описание |
/ адрес / [введите код] | Отдельная страна или регион |
/биография | Поле биографии: область с произвольным текстом, которую может редактировать только исследователь. |
/ education / [введите код] | Индивидуальный элемент принадлежности к образованию |
/ email / [введите код] | Индивидуальный адрес электронной почты, связанный с записью |
/ занятость / [код ввода] | Элемент индивидуальной занятости |
/ external-identifier / [код ввода] | Индивидуальный связанный внешний идентификатор в другой системе |
/ финансирование / [код ввода] | Индивидуальное финансирование |
/ ключевые слова / [введите код] | Индивидуальное ключевое слово, связанное с исследователем и его работой. |
/ other-names / [введите код] | Индивидуальное дополнительное имя, под которым известен исследователь |
/ peer-review / [ввести код] | Индивидуальная экспертная оценка |
/ research-urls / [введите код] | Индивидуальная внешняя ссылка на личную или профильную страницу исследователя |
/ work / [введите код] | Индивидуальная исследовательская работа |
/ works / [введите код1], [введите код2], [введите код3] | Массовые отдельные исследовательские работы (до 100) |
Используя конечную точку раздела и поместив код, вы можете вызвать API, используя тот же токен доступа, чтобы получить этот конкретный элемент полностью. Этот пример вызова извлекает полную статью финансирования 4413 в формате XML с помощью API-интерфейса участника на сервере песочницы.
Method: GET Accept: application/vnd.orcid+xml Authorization type and Access token: Bearer [stored access token]URI: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/funding/4413
API вернет сообщение 200 OK, чтобы указать, что сообщение было успешно получено, и вернет полный XML элемента финансирования:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<funding:funding put-code="4413" path="/0000-0002-9227-8514/funding/4413" visibility="public" [...] >
[...]
</funding:funding>
Вы можете проверить источник предмета при чтении, если вы хотите знать, кто это добавил.
Список распространенных кодов ошибок API, их возможные значения и советы по их устранению доступны в нашем техническая документация.
Если вы не можете решить возникшую проблему, сообщите нам об этом.
ORCID участники могут обновлять информацию, которую они ранее добавили в ORCID записывать. Только один элемент может быть обновлен за раз, и он может быть обновлен только с использованием учетных данных клиента, которые изначально создали его.
Чтобы упростить обновление, убедитесь, что вы сохранить код ввода и токен доступа при создании предметов.
Отформатируйте обновленный элемент in ORCID схема сообщения с измененной информацией и включить сохраненную поставить код.
<?xml version="1.0" encoding="UTF-8"?> <employment:employment put-code="739288" [...]> [...] </employment:employment>
Вызов API:
Method: PUT Content-type: application/vnd.orcid+xml or application/vnd.orcid+jsonnAuthorization type and Access token: Bearer [stored access token]Data: link to file or text of affiliation to update URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288
API вернет сообщение 200 OK, чтобы указать, что элемент обновлен правильно. Посетите нашу страницу устранения неполадок, если возвращается другое сообщение.
Видимость указывает настройку конфиденциальности элемента, основанную на настройках видимости, заданных пользователем. Если тег видимости включен при публикации информации через API, он будет проигнорирован. Скорее, информация будет публиковаться в соответствии с настройками видимости пользователя по умолчанию, установленными в настройках его учетной записи.
Публичные элементы могут быть прочитаны кем угодно через API и отображаются в общедоступной записи исследователя. Элементы доверенной стороны возвращаются через API только клиентам, имеющим доступ с ограниченным доступом для чтения; они не включены в публичные записи исследователя. Частные элементы видны только исследователю и источнику элемента. Через API возвращаются только те личные элементы, которые были добавлены в запись посредством вашей интеграции. Подробнее о настройках видимости в ORCID реестра.
Элементы (работы, трудоустройство, финансирование, экспертная оценка и т. Д.) Могут быть добавлены в ORCID запись с использованием ORCID член API. Для этого необходимо сначала получить разрешение исследователя с помощью OAuth и форматировать метаданные элемента используя ORCID схема сообщения.
После того, как вы отформатировали данные и собрали ORCID iD и токен доступа, вы делаете запрос API с помощью HTTP POST, указывая соответствующая конечная точка.
Method: POST
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]data: link to file or text of single employment item to add
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment
Призыв ниже добавляет новый занятость принадлежность к записи на сервере тестирования песочницы:
<?xml version="1.0" encoding="UTF-8"?>
<employment:employment [...]>
[...]
</employment:employment>
API вернет сообщение 201, указывающее, что элемент размещен правильно, вместе с элементом. поставить код. Ваш клиент будет указан как источник товара.
Ознакомьтесь с нашим Поиск и устранение неисправностей страница, если возвращается другое сообщение. Вам нужно будет сохранить сохранить код ввода и токен доступа для внесения каких-либо обновлений или удаления элемента.
Команда ORCID API поиска использует синтаксис SOLR. Поддерживаются все синтаксисы запросов, доступные в SOLR 3.6., включая Lucene с расширениями Solr (По умолчанию), DisMax и Extended Dismax.
Для его использования вам понадобится токен доступа «/ read-public». Получив токен поиска, создайте базовый URL поиска:
Тип учетных данных: | Публичный API | Членский API |
URL ресурса: | Песочница: https://pub.sandbox.orcid.org Производство: https://pub.orcid.org | Песочница: https://api.sandbox.orcid.org Производство: https://api.orcid.org |
Версия API: | v3.0 | |
Конечная точка поиска | / search /? = [запрос] |
Пример вызова поиска «orcid» с токеном в общедоступном API песочницы с результатами, возвращаемыми в формате XML:
Method: GET Content-type: application/vnd.orcid+xmlnAuthorization type and Access token: Bearer [stored access token]URL: https://pub.sandbox.orcid.org/v3.0/search/?q=orcid
Результаты будут указывать количество найденных результатов (num-found) и отображать первые 1000 результатов по умолчанию:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<search:search num-found="385" xmlns:search="https://www.orcid.org/ns/search" xmlns:common="https://www.orcid.org/ns/common">
<search:result>
<common:orcid-identifier>
<common:uri>https://sandbox.orcid.org/0000-0001-2345-6789</common:uri>
<common:path>/0000-0001-2345-6789</common:path>
<common:host>sandbox.orcid.org</common:host>
</common:orcid-identifier>
</search:result>
[...]
</search:search>
Пример базового поиска в общедоступном API песочницы с результатами, возвращаемыми в формате json:
Method: GET
Content-type: application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=newman
Поиск возвращает только человека ORCID iD записей, содержащих общедоступные данные, соответствующие поиску. Чтобы получить дополнительную информацию о результате, позвоните и прочтите ORCID записывать напрямую.
Для получения дополнительной информации см наш Руководство по API поиска.
Если вы добавили данные, которые необходимо удалить, например, если они были связаны с неправильным ORCID iD, то вы можете сделать HTTP-запрос DELETE, указав соответствующая конечная точка, вместе с ORCID я бы, сохраненный токен доступа и сохраненный код ввода. За один раз можно удалить только один элемент, и вы можете удалять только элементы, добавленные вашим клиентом. Вы можете удалять элементы, даже если пользователь отозвал разрешение.
В этом примере вызова из записи удаляется элемент занятости с кодом размещения «739288».
Method: DELETE
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288
Команда ORCID API поиска использует синтаксис SOLR. Поддерживаются все синтаксисы запросов, доступные в SOLR 3.6., включая Lucene с расширениями Solr (По умолчанию), DisMax и Extended Dismax.
Вы можете использовать полевой поиск, когда вам нужно выполнить поиск в определенном разделе ORCID записывать. Текущий список полей, распознаваемых при поиске API, вместе с соответствующими элементами структуры записи, выглядит следующим образом:
Поле поиска | Описание |
Биографические данные | |
второе имя | Данное (имя) имя (имена) пользователя. |
фамилия | Семейное (сур) имя пользователя. |
кредитное имя | «Опубликованное имя» на ORCID пользовательский интерфейс, имя, которое обычно появляется в публикациях пользователя |
Другие названия | Альтернативные названия, которые могли появляться в публикациях пользователя. |
Электронный адрес пользователя. | |
ключевое слово | Любые ключевые слова, связанные с пользователем. |
внешний идентификатор-ссылка | Идентификаторы из других систем, добавленные к пользователю ORCID запись с помощью API. |
Данные об аффилированности | |
название-организации | Название любой организации в элементе образования или занятости в записи пользователя. |
сетка-орг-идентификатор | Команда Идентификатор сетки любой организации в разделе действий записи пользователя. Обычно это связано с образованием или работой. |
ror-org-id | Команда идентификатор РОР любой организации в разделе действий записи пользователя. Обычно это связано с образованием или работой. |
Ringgold-Org-ID | Команда Рингголд ID* любой организации в разделе деятельности записи пользователя. Обычно это будет связано с образованием или трудоустройством. |
Данные о финансировании | |
финансирование-титулы | Название любой статьи финансирования в записи пользователя. |
Fundref-org-ID | Команда Идентификатор реестра Crossref Funder любой организации в разделе деятельности записи пользователя. Как правило, это будет связано с элементом финансирования, но также может быть связано с принадлежностью. |
номера грантов | Номер гранта (идентификатор) любой статьи финансирования в записи пользователя. |
Данные исследовательской деятельности | |
названия работ | Названия любых произведений в записи пользователя. |
идентификаторы цифровых объектов | Рабочий внешний идентификатор типа doi |
сделай сам | Рабочий внешний идентификатор с типом doi и отношением внешнего идентификатора, установленным на self. |
[тип внешнего идентификатора] * | Внешний идентификатор работы с заданным типом |
[тип внешнего идентификатора] * - собственный | Рабочий внешний идентификатор с заданным типом и отношением внешнего идентификатора, установленным на self. |
[тип внешнего идентификатора] * - часть | Рабочий внешний идентификатор с заданным типом и отношениями внешнего идентификатора, установленными как часть из |
[тип внешнего идентификатора] * - версия | Рабочий внешний идентификатор с заданным типом и отношениями внешнего идентификатора, установленными на версию-of * Полный список внешних идентификаторов см. список идентификаторов. Некоторые идентификаторы могут требовать «-self», «-part-of» или «-version-of» для возврата результатов. |
ORCID записывать данные | |
орхидея | 16-значный ORCID идентификатор пользователя в формате 0000-0001-2345-6789. |
дата отправки профиля | Дата и время создания записи. |
дата последнего изменения профиля | Дата и время последнего изменения записи. |
Все данные | |
текст | Все вышеперечисленные поля. Это также поле по умолчанию для синтаксических запросов Lucene. |
Смотрите наши Учебное пособие по API поиска чтобы получить больше информации.
*Хотя идентификаторы Ringgold все еще существуют в ORCID реестр, по состоянию на 1 августа 2023 г., ORCID больше не получает обновлений базы данных идентификаторов организаций RINGGOLD, используемой нашим реестром, и мы не сможем обрабатывать или использовать идентификаторы RINGGOLD, созданные после этой даты. Посмотрите наш FAQ для получения дополнительной информации
В реальных ситуациях взаимодействия с API выполняются вашей системой с использованием таких языков программирования, как PHP, Java или Ruby on Rails. Для практики и тестирования вы можете взаимодействовать с ORCID API-интерфейсы, использующие ряд инструментов, способных создавать и получать HTTP-запросы. Большинство настольных инструментов HTTP запускаются из командной строки; для тех, кто предпочитает графический интерфейс, полезной альтернативой являются веб-инструменты.
ПРОВЕРКА XML / XSD
Есть много инструментов, которые проверят ваш XML за вас; это хорошая идея принять его. Для многих вызовов API вы будете работать с информацией в формате XML. Особенно при работе с ORCID Сообщение API, важно, чтобы используемый XML соответствовал XSD. (См. Наш документация на GitHub для ORCID схема сообщения XSD.)
ORCID ТЕСТОВЫЙ СЕРВЕР SANDBOX
Команда сервер тестирования песочницы является копией ORCID Программное обеспечение реестра и содержит только данные тестирования. Он был разработан, чтобы предоставить место, где можно попробовать что-то, не влияя на реальные ORCID iD, особенно если вы работаете с ORCID API и нужно место для проверки вашей работы. Вы можете создавать учетные записи пользователей и тестировать вызовы API в песочнице, не беспокоясь о том, что это повлияет на производственные данные или случайно расшлет спам исследователям.
Вам даже не нужно быть ORCID член, чтобы опробовать членский API в песочнице. Все могут запросить учетные данные API участника песочницы и опробовать все функции, доступные для этого API.
Сайт и API не будут такими надежными, как для рабочих серверов. Мы не даем никаких гарантий относительно данных в песочнице; они не копируются и могут быть удалены. Песочница также может содержать некоторые экспериментальные функции, которых еще нет на рабочих серверах, поэтому вы можете опробовать их до того, как они появятся в реестре. Узнать больше о сервере тестирования песочницы или запросить учетные данные клиента.
ИНСТРУМЕНТЫ HTTP
Для выполнения HTTP-запросов доступно множество инструментов. Некоторые из них мы используем:
Премиум-члены могут зарегистрировать Webhooks против любого ORCID запись в реестре. Шаги:
Кодировать URL
URL-кодируйте нужный URL ORCID для вызова при обновлении записи пользователя. Например, следующий URL-адрес:
https://nowhere2.com/0000-0002-7465-2162/updated
становится
https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
Создайте URL
Создайте полный URL-адрес для ORCID Вызов API, начинающийся с URL-адреса ORCID запись, затем добавление ‚√∫/webhook‚√π и URL, который вы хотите вызвать. Так что это должно выглядеть как https://api.sandbox.orcid.org/{ORCID} / webhook / {URL-ENCODED-WEBHOOK-URL}
Например, используя указанный выше URL-адрес веб-перехватчика и ORCID iD 0000-0002-7465-2162, полный URL:
https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
Зарегистрируйте веб-перехватчик
Используйте свои веб-перехватчики, токен доступа, чтобы зарегистрировать свой веб-перехватчик против пользователя. ORCID записывать. Вам необходимо использовать HTTP-запрос PUT, но вы не должны ничего включать в тело запроса.
URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdatedn HEADER: Accept: application/json HEADER: Authorization: Bearer [Your access token]n HEADER: Content-Length: 0n METHOD: PUT
Ответ должен быть 201, но если обратный вызов уже существует, то ответ будет 204.
HTTP/1.1 201nServer: nginx/1.1.19nConnection: keep-alive Location: https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Frequestb.in%2Fz57lzcz5
URL-адрес для отмены регистрации веб-перехватчика такой же, как и для регистрации. Однако вам необходимо использовать метод HTTP DELETE.
URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
HEADER: Authorization: Bearer [Your access token]
HEADER: Content-Length: 0
METHOD: DELETE
Ответ должен быть 204 No Content
.
HTTP/1.1 204 No Content
Server: Apache-Coyote/1.1
Date: Fri, 05 Apr 2013 12:49:17 GMT
Команда ORCID Реестр выполнит следующий HTTP-вызов при обновлении записи. Запрос использует метод HTTP POST, но тело запроса пустое.
curl -v -X POST https://nowhere2.com/0000-0002-7253-3645/updated
Ваш сервер должен отвечать стандартными кодами ответа HTTP. Итак, если вызов был успешным, вы должны вернуть 204 No Content.
HTTP/1.1 204 No Content
Любой код ответа 2xx означает, что вызов был успешным. Если вы вернете код, отличный от 2xx, мы повторим звонок через пять минут.
В реальных ситуациях взаимодействия API выполняются вашей системой с использованием таких языков программирования, как PHP, Java или Ruby on Rails. Однако для практики и тестирования вы можете взаимодействовать с ORCID API с использованием ряда инструментов, способных создавать и получать HTTP-запросы. Большинство настольных инструментов HTTP (например, завить) запускаются в командной строке; для тех, кто предпочитает графический интерфейс, полезной альтернативой являются веб-инструменты.
Одним из популярных инструментов является Игровая площадка Google OAuth 2.0, бесплатный веб-инструмент, разработанный и поддерживаемый Google.
Пожалуйста, ознакомьтесь с нашим практическим руководством по API по адресу: https://info.orcid.org/hands-on-with-the-orcid-api/
Примечание: ORCID не поддерживает OAuth 2.0 Playground - этот инструмент был создан Google, который исключительно поддерживает его код. Хотя мы периодически обновляем эту документацию, время от времени могут быть некоторые неточности, поскольку мы можем не сразу узнавать об изменениях в OAuth 2.0 Playground.
Для нашей версии API 2.0 и выше ограничения следующие:
- Запрос второй - 24
- Взрыв - 40
Запросить секунду - количество запросов, которые могут быть выполнены в секунду.
Burst - Количество запросов, которые мы позволим поставить в очередь перед отклонением. Запросы в очереди замедляются до скорости запросов в секунду. Если вы превысите пакет, вы получите ответ 503.
Если у вас возникли проблемы с ограничениями, обратитесь за поддержкой к руководителю группы по взаимодействию.
Контроль исследователя - это основа ORCID принцип поэтому адреса электронной почты зарегистрированы и добавлены в ORCID запись по умолчанию установлена как видимая только для владельца записи. Непроверенные электронные письма не отображаются в общедоступном просмотре записи, и только проверенные адреса электронной почты будут отображаться в результатах API.
После того, как исследователи подтвердили свой адрес электронной почты, они должны сделать его видимым для всех (т. Е. Общедоступным) или для доверенных лиц (т. Е. С ограниченным доступом), чтобы адрес электронной почты мог быть прочитан сторонними организациями.
Если исследователь установил свой адрес электронной почты для доверенных сторон, он будет возвращен вместе с записью, если исследователь предоставил вам доступ с ограничением чтения, Для получения дополнительной информации см. ORCID настройки видимости.
API 3.0 является версией API по умолчанию, и мы рекомендуем использовать эту версию при создании новых интеграций. Мы продолжим поддерживать API 2.0 и 2.1 в обозримом будущем и предоставим уведомление как минимум за 12 месяцев до отключения этих версий.
Мы многому научились при переходе с API 1.2 на API 2. На этот раз мы упростили управление обновлением. API 3.0 добавляет новые функции, изменяя существующие функции только в случае крайней необходимости. Это означает, что интеграторы должны иметь возможность переключиться на новый API с минимумом суеты. Это также означает, что, хотя мы рекомендуем вам начать планировать обновление как можно скорее, чтобы ваша организация и исследователи могли извлечь выгоду из новых функций, у вас есть большая гибкость при принятии решения, когда выполнять обновление до версии 3.0.
Небольшой список потенциально критических изменений находится в наших примечаниях к выпуску API. здесь и здесь. Внесены некоторые изменения в необязательные / обязательные поля, перечисления JSON были немного изменены, и мы также провели небольшой рефакторинг наших схем XML, добавив некоторые новые поля, содержащие метаданные, необходимые для новой функциональности.
Пожалуйста, обратитесь к ORCID страница систем с поддержкой поставщиков для издателей для самой актуальной информации
Любой премиум-участник может получить токен доступа «/webhook». Один токен можно использовать для регистрации веб-перехватчиков для нескольких записей. Чтобы получить токен, вы звоните в ORCID Конечная точка токена API.
Этот процесс часто называют потоком OAuth для учетных данных клиента или двухэтапным OAuth.
Ниже приведен пример вызова для получения токена доступа - замените заполнители своими учетными данными (обязательно удалите скобки).
curl -i -L -H "Accept: application/json"
-d "client_id=(your client ID)"
-d "client_secret=(your client secret)"
-d "scope=/webhook"
-d "grant_type=client_credentials"
"https://sandbox.orcid.org/oauth/token"
Затем вам будет возвращен токен доступа, подобный приведенному ниже.
{"access_token":"5eb23750-1e19-47a3-b6f6-26635c34e8ee",
"token_type":"bearer",
"refresh_token":"c7d3d5fd-e4c0-4825-89f2-7cfb4a1cf01e",
"expires_in":631138518,
"scope":"/webhook"}
Да! Вы можете узнать больше о нашем управлении версиями API, его обосновании и многом другом здесь, в нашем Политика версий API.
По мере продолжения разработки наших продуктов ряд функций доступен только в API 3.0, который является нашей последней версией API по умолчанию.
В таблице ниже представлено краткое описание каждой функции. Если у вас есть какие-либо вопросы относительно каких-либо функций или обновления до 3.0, обратитесь к своему руководителю по взаимодействию или руководителю консорциума.
Возможность читать и писать все типы принадлежности (членство, услуги, приглашенные должности, различия и квалификации недоступны в предыдущих версиях API) |
Умение читать и писать исследовательские ресурсы. |
Возможность чтения и записи идентификаторов работы с типом отношения «Финансируется». Это используется для привязки идентификаторов грантов или предложений к рабочим метаданным. |
Возможность чтения и записи идентификаторов работы с типом связи «Версия». Это используется для связывания других версий работы вместе. Примером использования может быть связь препринта и опубликованной статьи. |
Возможность читать и писать роли CRediT в метаданных работ. |
Возможность читать дополнительные исходные поля общие: утверждение-происхождения-идентификатор-клиента и общий: имя-источника-утверждения для аффилированных лиц, добавленных ORCID членский портал и работы, добавленные мастерами поиска и ссылок. |
Умение читать и писать работает с типом работы: аннотирование планы управления данными диссертация препринт физический объект обзоре |
Возможность чтения и записи внешних идентификаторов для аффилированных лиц. |
Идентификаторы организации являются обязательными для добавления членства и финансирования в ORCID Records. |
Формализация идентификаторов. Мы представили новое системное поле, которое выражает внешние идентификаторы (DOI, PMCID, PMID, ArXiv, Bibcode, ISSN и ISBN) в нормализованном формате для целей сопоставления и группировки. Нормализация выполняется на основе правил типа идентификатора и может включать перевод всех буквенных символов в нижний регистр или преобразование пробелов, тире, точек и других символов, которые можно рассматривать как эквивалентные. Он также добавляет стандартные префиксы и суффиксы по мере необходимости. Например, https://doi.org/10.1/123, 10.1/123и https://dx.doi.org/10.1/123 все появятся в этом поле как https://doi.org/10.1/123. Существующее значение идентификатора не изменяется. |
Более подробную информацию можно найти здесь.
Другое
Они получают уведомление в своем ORCID входящие. Всякий раз, когда есть изменение данных на ORCID запись, пользователь получает уведомление с базовой информацией об изменении, включая имя клиента, выполняющего обновление, дату изменения и элемент в ORCID запись, которая была обновлена. Смотрите наши База знаний пользователя для получения дополнительной информации об уведомлениях.
ORCID записи в песочнице также есть функционирующие почтовые ящики. Мы рекомендуем регулярно просматривать почтовые ящики вашего тестирования. ORCID записи при планировании того, как ваши системы будут планировать обновления данных.
Обновления и другие объявления для пользователей API публикуются через ORCID Группа пользователей API. Вы также можете подписаться на общие сообщения и обновления через ORCID Блог.
ORCID члены также получают ORCID Информационный бюллетень участника, где эта информация включена. Наконец, технический контакт для любого ORCID участник с активной настраиваемой интеграцией также будет получать сообщения электронной почты о любых критических обновлениях ORCID Реестр. Если вы хотите, чтобы вас указали в качестве контактного лица по техническим вопросам для вашей организации, пожалуйста, Контакты.
ORCID стремится быть открытым и прозрачным. Это означает, что наши дорожная карта продукта доступен для просмотра всем, как и работа в настоящее время в разработке.
Дорожная карта продукта занимает центральное место в ORCID процесс разработки продукта. Требования передаются от досок trello, управляемых командой, через доску trello Roadmap продукта и далее на доску trello Current Development, где они внедряются и перемещаются в наши производственные системы.
Эта плата содержит четко определенные требования, которые планируется реализовать. в какой-то момент, а также список приоритетных требований, которые планируется реализовать в ближайшем будущем.
Откуда берутся требования?
Требования собраны из многих источников ORCID персонал. Они могут быть вызваны, среди прочего, запросами участников, отзывами консорциума, пользовательским тестированием, стратегическими проектами и отчетами об ошибках. Кроме того, все ORCID команды создают свои собственные внутренние требования, такие как изменения веб-сайтов, обновления инфраструктуры и обновления операционных систем. Каждая карточка помечена командой, которая создала требование: связь, стратегия, технология, взаимодействие или операции.
Как дела в дорожной карте?
ORCID стремится к сбалансированному циклу разработки продукта и проводит регулярные встречи всех команд для обсуждения ближайших и долгосрочных приоритетов. Мы делаем все возможное, чтобы исправлять ошибки, новые функции, технические проблемы, обновления веб-сайтов и стратегические вопросы в равной степени.
Как я могу внести свой вклад в дорожную карту?
Мы приветствуем предложения о том, как улучшить ORCID реестр. Пожалуйста, отправляйте любые отзывы по адресу наша команда.
Кроме того, ORCID это проект с открытым исходным кодом, и мы приветствуем вклад в наш исходный код, а также все наши репозитории.
Препринт — это законченная научная рукопись, которую авторы загружают на общедоступный сервер. Препринт содержит полные данные и методологии; часто одна и та же рукопись представляется в журнал. После краткого контроля качества, чтобы убедиться, что работа носит научный характер, рукопись автора размещается в течение дня или около того в Интернете без рецензирования и может быть просмотрена бесплатно кем угодно в мире. На основе отзывов и/или новых данных могут быть представлены новые версии вашего препринта; однако предыдущие препринты также сохраняются. Серверы препринтов позволяют ученым напрямую контролировать распространение своей работы среди мирового научного сообщества. В большинстве случаев та же работа, опубликованная в виде препринта, также отправляется на рецензирование в журнал. Таким образом, препринты (быстрые, но не подтверждаемые рецензированием) и журнальные публикации (медленные, но обеспечивающие проверку с помощью рецензирования) работают параллельно как коммуникационная система для научных исследований.
Примечание. Этот контент и видео изначально были размещены на Сайт ASAPBio Спасибо ASAPBio за то, что сделали его доступным по лицензии CC-BY!
Информационный бюллетень для участников, отправляемый ежемесячно от ORCID ранее содержал ссылку на папку Google Диска, где хранились все отчеты ваших участников. Теперь он был заменен новыми отчетами, доступными для всех участников в членский портал.
Предыдущие отчеты:
- Премиум-участники с активной интеграцией получите уникальную ссылку на папку, содержащую отдельные настроенные отчеты с данными по каждой интеграции за предыдущий месяц.
- Премиум-участники, у которых еще нет активной интеграции получите уникальную ссылку на папку, содержащую настроенные отчеты со статистикой электронной почты для своего учреждения, а также ссылку на папку, которая содержит общие отчеты с агрегированными данными для всех интеграций активных участников.
- Основные члены получать ссылку на папку, содержащую общие отчеты, выпускаемые дважды в год, с агрегированными данными по всем интеграциям активных участников за предыдущие полгода; отчет за первое полугодие выдается в июль (Данные за январь-июнь), отчет за второе полугодие, опубликованный в январь (Июль-декабрь следующего года).
Если вы ORCID член и в настоящее время не получают ежемесячный информационный бюллетень для участников, пожалуйста, свяжитесь с [электронная почта защищена]
Премиум-участники с активной интеграцией
Папка Google Диска содержит отчет участника для каждого выпущенного вам iD рабочего клиента. Имена файлов включают отображаемое имя клиента. iD и дату отчета; пожалуйста, отсортируйте по дате изменения, чтобы найти самый последний отчет. Также имеется папка raw_data, содержащая данные, использованные для создания отчета, который при необходимости доступен для дополнительного анализа.
Премиум-участники, у которых еще нет активной интеграции
Папка Google Диска содержит отчет участника только с данными статистики по электронной почте, а также ссылку на папку Диска Google с общими ежемесячными отчетами с агрегированными данными по всем интеграциям активных участников за текущий и предыдущие годы. Для этих отчетов необработанные данные недоступны.
Количество доменов электронной почты
В этом разделе содержится подсчет ORCID iDs в настоящее время зарегистрировали домены электронной почты вашего учреждения за все периоды времени. Чтобы произвести эти подсчеты, мы ищем домены, которые соответствуют URL-адресу веб-сайта, который у нас есть в файле для вашей организации (например, если URL-адрес вашего веб-сайта www.universitycollege.edu, мы ищем электронные письма, оканчивающиеся на @universitycollege). Если у нас нет URL-адреса веб-сайта в файле, вы увидите ‚√∫Домены электронной почты не указаны‚√π в этом разделе. Если мы не совсем правильно определили домен вашей электронной почты или если вы хотите добавить дополнительные домены, пожалуйста, Контакты.
- Записи, зарегистрированные в ваших доменах электронной почты¬¨‚Количество уникальных ORCID идентификаторы, которые включают адрес в пределах домена(ов) электронной почты вашего учреждения.
- Записи, зарегистрированные в ваших доменах электронной почты И связанные с вашим идентификатором клиента¬¨‚Количество уникальных ORCID идентификаторы, которые включают адрес в домене (доменах) электронной почты вашего учреждения И включают ваше учреждение в качестве доверенной стороны (т. е. записи, для которых ваше учреждение имеет действительный токен доступа)
Созданные и заявленные записи
(Примечание: у большинства клиентов не будет этого раздела в своих отчетах)
Если у вас есть институциональный клиент, который использовался для создания записей от имени исследователей через API, вы получите раздел под названием «Статистика реестра». Сюда входит информация о количестве созданных вами записей и о том, сколько из них было заявлено (файл raw_data содержит дополнительную информацию о конкретных записях, использованных для генерации этих чисел).
Пользователи
В этом разделе отчета содержится общее количество исследователей, которые использовали вашу интеграцию для подключения своих ORCID iD в вашу систему в течение месяца отчетности. Кроме того, здесь указано общее количество тех исследователей, которые подписались на новый ORCID iD как часть iD процесс подключения.
График с пометкой «Всего событий интеграции» показывает количество исследователей, которые использовали вашу интеграцию за последний месяц, по дням.
Мероприятия
Отчет также содержит События информации, действия, которые совершил исследователь при подключении своих ORCID сделайте запись с вашей системой в отчетном месяце. Каждое событие представляет собой любой доступ, предоставленный пользователем, или действие, которое он выполнил на ORCID сайт (например, вход в систему или предоставление доступа с ограничением чтения). У большинства исследователей с ними связано более одного события.
Если к событию добавлен ‚√∫√π, это означает, что исследователь предоставил долгоживущий (Pпостоянный) токен по сравнению с токеном с коротким сроком действия, срок действия которого истекает через один час. С марта 2018 года на платформе поддерживаются только долгоживущие токены. ORCID Реестр; ваша интегрированная система или пользователь могут отозвать токен в любое время.
Пользователи по странам
Последний раздел отчетов содержит информацию об исследователях, которые использовали вашу интеграцию, разбитую по странам, из которых они получили доступ к вашей интеграции. Эти данные извлекаются из IP-адреса исследователя или его географического идентификатора (который сам определяется Google из IP-адреса исследователя).
Отбор проб
Поскольку так много исследователей используют ORCID Реестр, невозможно запустить отчеты по всему набору данных исследователя. Вместо этого приведенные здесь числа получены с использованием тенденций из выборочного и невыборочного набора. Разделы отчета, полученные на основе выборочных данных, отмечены звездочкой, а размер и объем выборки указаны на вкладке Данные аналитики. Цифры в разделе отчета Google Analytics могут не полностью соответствовать какой-либо локальной статистике, которую вы ведете, и могут быть небольшие расхождения в количестве между разделами отчета.
Параметры выборки, перечисленные под Integration Analytics, применяются ко всем разделам, отмеченным звездочкой. Процент сеансов, захваченных аналитическими данными, составляет (размер выборки) / (пространство выборки) * 100%. Дополнительную информацию о взятии проб можно найти на сайте Разработчики Google.
Пустые отчеты
Разделы отчета «Пользователи» и «События» включают данные только за последний месяц. Если ни один исследователь не использовал вашу интеграцию в прошлом месяце, данные не будут возвращены.
вопросы
Если у вас есть какие-либо вопросы по поводу отчетов ваших участников, пожалуйста, Контакты.
Команда ORCID Реестр предназначен для того, чтобы пользователи предоставляли свои iD организациям, использующим OAuth, что гарантирует правильность iD собирается для каждого исследователя. Мы не рекомендуем организациям добавлять ORCID iD в свои системы, основанные на поиске исследователей по именам. Однако может быть полезно узнать, сколько исследователей в вашей организации ORCID iDs, что можно сделать через API. Ниже приведены предложения по поиску по организациям.
Чтобы получить представление о поиске, о том, как получить токен доступа, о том, как понимать результаты поиска, а также подробную информацию о других полях, в которых можно выполнять поиск, см. Наши Поиск в руководстве по API реестра
Поиск по имени и DOI
При проверке, есть ли у человека ORCID record, мы рекомендуем искать как по их имени, так и по DOI одной или нескольких их недавних работ. Это должно привести к записи только того исследователя, которого вы ищете, а не записей кого-либо еще с таким же именем.
Пример вызова для поиска всех записей с именем «Laurel Haak» и либо DOI 10.1087 / 20120404, либо DOI 10.6084 / M9.FIGSHARE.1115124:
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search?q=family-name:Haak+AND+given-names:Laurel+AND+digital-object-ids:%2210.1087/20120404%22+OR+digital-object-ids:%2210.6084/M9.FIGSHARE.1115124’%22
Поиск по принадлежности
Поля аффилированности можно искать, используя либо название аффилированности, либо уникальный идентификатор ROR или идентификатор GRID организации. (Идентификатор GRID вашей организации можно найти в GRID или ваш ROR ID в Реестр ROR)
Поиск по названию организации
Method: GET Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:"University+of+Johannesburg"
Или на точное совпадение
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:(%22Boston%20University%22)
Поиск по GRID ID
Пример вызова для поиска всех записей с идентификатором GRID grid.5509.9 (Университет Тампере):
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=grid-org-id:grid.5509.9
Поиск по ROR ID
Пример вызова для поиска всех записей с ROR ID 04fa4r544 (ORCID):
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=ror-org-id:"https://ror.org/04fa4r544"
Поиск по домену электронной почты
Вы можете использовать API для поиска исследователей по домену электронной почты. Имейте в виду, что около 97% адресов электронной почты в ORCID являются частными, и любые записи с частным или защищенным адресом электронной почты не будут возвращены в этом поиске.
Пример вызова для поиска всех записей с адресом электронной почты @orcid.org:
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=email:*@orcid.org
Результаты поиска возвращаются в формате CSV
Результаты поиска также могут быть возвращены в формате CSV. В рамках вызова вы можете указать выходные столбцы из списка доступных полей ниже:
орхидея
e-mail
собственное имя
фамилия
имена и фамилии
кредитное имя
другое имя
имя-филиала-текущего учреждения
имя-филиала-учреждения в прошлом
Используя свои учетные данные, вам необходимо указать заголовок, который будет 'текст / csv '. В рамках поискового вызова вам также необходимо добавить в запрос поля, которые требуются для вывода.
Поиск с использованием только вашего браузера
Вы также можете выполнить поиск в браузере. URL-адрес создается таким же образом, но вам не нужно использовать какие-либо учетные данные API. Обратите внимание, что это можно сделать только с помощью общедоступного API.
Ниже приведен пример вызова с использованием общедоступного API для поиска по названию организации с ORCID, заданные имена, фамилии, название текущего учреждения и название предыдущего учреждения в качестве желаемого результата.
https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:ORCID&fl=orcid,given-names,family-name,current-institution-affiliation-name,past-institution-affiliation-name
Ниже приведен еще один пример вызова с использованием общедоступного API для поиска по различным вариантам названия организации.
https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:("University of Plymouth" OR "Plymouth University")
Схема eduPerson добавила eduPersonOrcid атрибут в его Февральское обновление 2016.
В соответствии с спецификация eduPerson:
RFC4512 definition
( 1.3.6.1.4.1.5923.1.1.1.16
NAME 'eduPersonOrcid'
DESC 'ORCID researcher identifiers belonging to the principal'
EQUALITY caseIgnoreMatch
SYNTAX '1.3.6.1.4.1.1466.115.121.1.15' )
Обратите внимание, что формат этого поля - ORCID-предпочтительное представление URI iDт.е. https://orcid.org/0000-0001-5727-2427.
Дополнительная информация о формате ORCID iD можно найти в Структура ORCID идентификатор.
ORCID был основан на принцип что исследователи должны контролировать свою информацию. Чтобы соблюдать этот принцип, у нас есть сильная политике конфиденциальности, который был разработан с учетом местных различий в правилах конфиденциальности, и мы ориентируемся на точку зрения исследователя при разработке политик и функций.
В соответствии с нашими основной принцип исследовательского контроля, ORCID записи могут быть созданы только самими исследователями на ORCID Веб-сайт.
В рамках рабочего процесса интеграции ваши исследователи смогут зарегистрироваться для нового ORCID iD или войдите в их существующую запись, чтобы вы могли собирать их аутентифицированные ORCID я бы. Пожалуйста, посмотрите наш API учебники чтобы получить больше информации.
Если вы считаете, что данные, представленные в вашем отчете, неточны, пожалуйста, Контакты как можно подробнее, и наша команда по взаимодействию проведет расследование.
Если ваша организация ORCID член, тогда вам нужно обратиться к ORCID контакт в вашей организации, который сможет предоставить вам доступ к ORCID Членский портал. Если вы не можете идентифицировать свою организацию ORCID свяжитесь с руководителем консорциума или представителем группы взаимодействия.
Нам нравится получать отзывы от нашего сообщества, поэтому сообщите нам, если у вас есть отзывы об отчетах участников, связавшись с нами по адресу https://support.orcid.org/hc/en-us/requests/new
Мы составили руководство, которое проведет вас по каждому разделу отчетов. Руководство можно найти здесь.
Данные, которые используются для создания отчетов об участниках и интеграции, обновляются ежедневно.