В этом руководстве описывается, как искать ORCID Реестр с использованием ORCID общедоступный и членский API. Для обоих этих методов требуется токен доступа, полученный с использованием ваших учетных данных клиента.
Команда ORCID API поддерживает поиск по подмножеству ORCID метаданные с использованием популярного синтаксиса запросов Solr. Обратите внимание, что только ORCID iDis вернулся в результатах поиска. Информация о получении данных из определенного ORCID iD можно найти в Чтение данных из ORCID запись.
Поиск по API может не подходить для вашего использования. Вы можете рассмотреть следующие альтернативы:
- Поиск исследователя ORCID я бы? Мы не рекомендуем вручную вводить какие-либо ORCID идентификаторы в ваши системы или процессы. Мы советуем вам собирать аутентифицированные ORCID ID от ваших исследователей.
- ORCID выпускает годовой файл общедоступных данных - снимок всех общедоступных данных в ORCID Реестр в этот момент времени, который также можно использовать для поиска больших общедоступных данных в реестре. Премиум ORCID участники также могут получить доступ к файлу данных по запросу, используя общедоступная синхронизация данных.
- Конкретные инструкции по поиску большого количества исследователей вашего учреждения см. В наших советы по поиску ORCID рекордсмены в вашем учреждении
Ограничения поиска по общедоступному API
Обратите внимание, что общедоступный API ограничен 10,000 XNUMX результатами. Использование API участника (с токеном API участника) не ограничивает количество результатов.
Вы можете облегчить жизнь своим пользователям, подключив подтвержденную информацию к их ORCID записи. Вы также поможете укрепить доверие к научным коммуникациям и, поддерживая эти данные в актуальном состоянии, вы сможете уменьшить бремя отчетности для ваших пользователей и улучшить качество данных.
ORCID для исследовательских организаций
Помимо использования в качестве постоянного идентификатора для ваших исследователей, ORCID может помочь вам взять под контроль использование названия вашего учреждения в исследовательских системах. В сочетании с другими постоянными идентификаторами ORCID позволяет вам авторитетно утверждать, что ваши сотрудники, преподаватели и студенты связаны с вашим учреждением. Вы также можете использовать ORCID API-интерфейсы для получения уведомлений об исследовательской деятельности в режиме реального времени, для автоматического обновления форм и отслеживания карьеры выпускников.
ORCID для финансирующих организаций
Путем встраивания ORCID iDs в ваших рабочих процессах финансирования, вы можете надежно связать своих получателей грантов и программы финансирования - и сэкономить время каждого и уменьшить количество ошибок, вызванных вводом информации вручную. С использованием ORCID в вашей системе (ах) вы можете сыграть свою роль в создании надежной инфраструктуры исследовательской информации, установив связи между людьми и грантами, которые вы им присуждаете.
ORCID для издателей
Исследователи лежат в основе всего, что делают научные и исследовательские издатели. Точная информация об авторе и рецензенте имеет жизненно важное значение для индексирования, поиска и обнаружения, отслеживания публикаций, определения финансирования и использования ресурсов, а также для поддержки рецензирования.
ORCID служит информационным центром, позволяя вашим авторам и рецензентам надежно подключаться к своим материалам и обмениваться информацией из своих ORCID записывайте, как они взаимодействуют с вашими издательскими системами. Сбор идентификаторов для всех ваших авторов и рецензентов в процессе публикации — будь то для книг, журналов, наборов данных, композиций, презентаций, кода или множества других работ — позволяет легко обмениваться информацией, гарантирует, что исследователи могут дать согласие на обмен, экономит время и усилия исследователей, снижает риск ошибок и, что особенно важно, позволяет исследователям получить признание, которого они заслуживают за важную работу, которую они выполняют.
Интегрируя ORCID в вашу систему позволяет вашей организации собирать проверенные ORCID iDs и добавьте их к своим собственным данным. В то же время исследователь предоставляет организации разрешение на чтение и запись в свои сети и обратно. ORCID записи.
Чтобы добиться этой цели, организации ОБЯЗАТЕЛЬНО получать подлинности ORCID ID используя ORCID API OAuth. Это означает, что они включают в себя ORCID фирменная кнопка или ссылка в их системе, при нажатии на которую пользователю предлагается войти в свою учетную запись. ORCID записи.
После входа в систему пользователю будет предложено авторизовать доступ к системе с запросом его ORCID iD
пользователя ORCID iD и имя на ORCID запись (в зависимости от настроек видимости) возвращается в организацию в рамках этого процесса. Затем система может запросить дополнительные данные у ORCID API.
Описанный выше рабочий процесс сбора аутентифицированных API доступен как в ORCIDобщедоступные и членские API. Первый доступен для бесплатного использования некоммерческими сервисами.
Получите токен поиска
Любой, у кого есть учетные данные API, может искать ORCID Реестр. Членский API требует / read-public токен доступа для выполнения вызовов API. Чтобы получить токен, позвоните в ORCID API, использующий двустороннюю авторизацию OAuth (т.е. вызов напрямую к API). Вызов одинаков для учетных данных общедоступного и членского API.
Любой человек с общедоступными учетными данными или учетными данными 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 записывать конспекты.
Базовый поиск по ключевым словам
Поиск можно выполнять в тестовом реестре песочницы или в рабочем реестре. Конечная точка API поиска принимает запросы GET для HTTP. Единственный требуемый ввод — это строка запроса, которая передается поисковой системе Solr.
Команда 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 поиска.
Расширенный поиск
В дополнение к базовому поиску, расширенная конечная точка поиска расширенный поиск доступен. Использование этой конечной точки возвращает следующую информацию: идентификатор орцида, имена, фамилии, кредитные имена, другие имена, адрес электронной почты и учреждение при использовании стандартного синтаксиса поиска. Результаты могут быть возвращены в формате XML или JSON.
Пример поиска в общедоступном API песочницы по запросу «jones»
URL: https://pub.sandbox.orcid.org/v3.0/expanded-search/?q=spaceman
В результате получается что-то вроде этого:
<expanded-search:expanded-result>
<expanded-search:orcid-id>0000-0002-2436-0000</expanded-search:orcid-id>
<expanded-search:given-names>Dave Theodore</expanded-search:given-names>
<expanded-search:family-names>Spaceman</expanded-search:family-names>
<expanded-search:other-name>D Spaceman</expanded-search:other-name>
<expanded-search:other-name>D T Spaceman</expanded-search:other-name>
<expanded-search:institution-name>The University of The Moon</expanded-search:institution-name>
<expanded-search:institution-name>Saturn Institute</expanded-search:institution-name>
</expanded-search:expanded-result>
Результаты поиска возвращаются в формате CSV
Результаты поиска также могут быть возвращены в формате CSV. В рамках вызова вы можете указать выходные столбцы из списка доступных полей ниже:
- орхидея
- собственное имя
- фамилия
- имена и фамилии
- кредитное имя
- другое имя
- имя-филиала-текущего учреждения
- имя-филиала-учреждения в прошлом
Используя свои учетные данные, вам необходимо указать заголовок, который будет 'текст / csv '. В рамках поискового вызова вам также необходимо добавить в запрос поля, которые требуются для вывода.
Пример вызова участника, осуществляющего поиск по идентификатору RingGold* с необходимыми выводами, включая ORCID, имя и принадлежность.
Method: GET
Content-type: text/csv
Authorization type: Bearer
Access token: [Stored access token]
URL: https://api.orcid.org/v3.0/csv-search/?q=ringgold-org-id:385488&fl=orcid,given-names,family-name,current-institution-affiliation-name,'
Вы также можете выполнить поиск в браузере. 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”)
Форматирование поисковых запросов
Поведение по умолчанию - это неограниченный поиск произвольной формы по всем доступным проиндексированным полям. Таким образом, при базовом поиске по запросу «newman» будут обнаружены исследователи с опубликованным именем Newman, именем Newman или связанными с работой с «newman» в названии и т.д. в типе содержимого.
API также поддерживает логический поиск с использованием нескольких ключевых слов, точных фраз и других функций логического поиска. Ключевые слова должны быть объединены в квадратные скобки и заглавными буквами «И» или «ИЛИ» - строчные «и» и «или» рассматриваются как часть поиска.
Пример логического поиска в общедоступном API песочницы для записей, соответствующих трем ключевым словам (johnson, cardiology и houston):
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+AND+cardiology+AND+houston
Пример логического поиска в общедоступном API песочницы для записей, соответствующих ключевому слову «johnson» и ключевому слову «caltech» или фразе «Калифорнийский технологический институт», и результаты, возвращаемые в формате XML:
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+AND+(caltech+OR+"California+Institute+of+Technology")
Искать определенные элементы по полю
Вы можете использовать полевой поиск, когда вам нужно выполнить поиск в определенном разделе ORCID записи.
Базовым синтаксисом для поиска по полю является поле: значение, поэтому строка запроса family-name: james найдет запись с фамилией «Джеймс», например «Роланд Джеймс», но не записи с именем «Джеймс», например как «Джеймс Джонсон».
Можно указать несколько пар поле: значение. Сопоставление основано на токенах подстроки, а не на необработанных строках, поэтому строка запроса other-names: carberry будет соответствовать как J. Carberry, так и JS Carberry.
Команда 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 возвращает 1000 результатов (или строк) по умолчанию как для общедоступного, так и для членского API. Чтобы отобразить сразу определенное количество результатов или получить более первых 1000 результатов, добавьте параметры для начальной точки и количества результатов. Максимальное количество результатов, которые могут быть возвращены за один раз, также равно 1000.
Пример поиска в общедоступном API песочницы для вторых 1000 результатов, соответствующих ключевому слову «orcid»:
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=orcid&start=1000&rows=1000
Пример поиска в общедоступном API песочницы элементов 2–4 при поиске с использованием терминов «джонсон», «кардиология» и «хьюстон»:
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+cardiology+houston&start=2&rows=3
Примеры запросов с использованием общедоступного API
Ограничения поиска по общедоступному API
Обратите внимание, что общедоступный API ограничен 10,000 XNUMX результатами. Использование API участника (с токеном API участника) не ограничивает количество результатов.
Пример 1
Искать фамилии всех ORCID записи на имя «Санчес»
Синтаксис: | Люсен |
Пейджинг: | Только ряды 5-10 |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=family-name:Sanchez&start=4&rows=6 |
Пример 2
Искать во всех доступных для поиска полях ORCID записи для слова «английский»
Синтаксис: | Люсен |
Пейджинг: | Только первые 10 рядов |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=text:English&start=0&rows=10 |
Пример 3
Поиск участников, связанных с работой, в PubMed ID 2485-7732.
Синтаксис: | Люсен |
Пейджинг: | Все записи |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=pmid:24857732 |
Пример 4
Найдите записи с фамилией «Эйнштейн» и ключевым словом «Относительность». Будут возвращены только записи, содержащие как фамилию, так и ключевое слово.
Синтаксис: | Люсен |
Пейджинг: | Только первые 10 рядов |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=family-name:Einstein+AND+keyword:Relativity&start=0&rows=10 |
Пример 5
Найдите записи с фамилией Тейлор и именем Майкл.
Синтаксис: | Люсен |
Пейджинг: | Все результаты |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=family-name:Taylor+AND+given-names:Michael |
Пример 6
Поиск по именам и фамилиям всех ORCID записи для «Раймонд», но увеличивают фамилию. Записи с заданными именами, содержащими «Raymond», и фамилиями, содержащими «Raymond», будут возвращены, но записи с фамилией будут отображаться вверху списка и будут иметь более высокий балл релевантности.
Синтаксис: | Расширенный DisMax |
Пейджинг: | Только первые 10 рядов |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?defType=edismax&q=Raymond&qf=given-names^1.0%20family-name^3.0&start=0&rows=10 |
Пример 7
Поиск по именам и фамилиям всех ORCID записи для «Раймонд», но увеличивают фамилию. Записи с заданными именами, содержащими «Раймонд», и фамилиями, содержащими «Раймонд», будут возвращены, но записи с фамилией будут отображаться вверху списка и будут иметь более высокий балл релевантности. Две записи с ORCID Идентификаторы https://sandbox.orcid.org/0000-0002-0879-455X и https://sandbox.orcid.org/0000-0001-6238-4490 будут исключены из результатов.
Синтаксис: | Расширенный DisMax |
Пейджинг: | Только первые 10 рядов |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?defType=edismax&q=Raymond+-orcid:(0000-0002-0879-455X+0000-0001-6238-4490)&qf=given-names^1.0+family-name^3.0&start=0&rows=10 |
Пример 8
Поиск записей с точным DOI 10.1087 / 20120404, установленным на self
Пейджинг: | По умолчанию |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=doi-self:%2210.1087/20120404%22 |
Пример 9
Поиск записей с DOI, который включает 10.1087, установленный либо на себя, либо на часть
Пейджинг: | По умолчанию |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=digital-object-ids:10.1087 |
Пример 10
Поиск записей с идентификатором PubMed 27281629, установленным на self
Пейджинг: | По умолчанию |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=pmid-self:27281629 |
Пример 11
Искать записи с идентификатором ISBN, включая 1234, установленный на себя или часть
Пейджинг: | По умолчанию |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=isbn:1234 |
Пример 12
Поиск всех записей с адресом электронной почты в домене @orcid.org.
Пейджинг: | По умолчанию Примечание: большинство ORCID записи имеют адрес электронной почты, помеченный как личный, и личная информация не будет возвращена в результатах поиска. |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=email:*@orcid.org |
Пример 13
Поиск записей, измененных с 1 января 2017 г. по сегодняшний день
Пейджинг: | Первые 10 результатов |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=profile-last-modified-date:%5B2017-01-01T00:00:00Z%20TO%20NOW%5D&start=1&rows=10 |
Пример 14
Найдите записи, связанные с организацией с точным названием «Бостонский университет» или «BU».
Пейджинг: | По умолчанию |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=affiliation-org-name:(%22Boston%20University%22+OR+BU) |
Пример 15
Поиск записей, связанных с идентификатором Ringgold ID* 1438 (Калифорнийский университет в Беркли), в формате CSV
Пейджинг: | По умолчанию |
URL: | https://pub.sandbox.orcid.org/v3.0/csv-search/?q=ringgold-org-id:1438 |
Пример 16
Найдите записи, связанные с идентификатором GRID Grid.5509.9 (Университет Тампере), используя расширенный поиск.
Пейджинг: | По умолчанию |
URL: | https://pub.sandbox.orcid.org/v3.0/expanded-search/?q=grid-org-id:grid.5509.9 |
* Хотя идентификаторы Ringgold все еще существуют в ORCID реестр, по состоянию на 1 августа 2023 г., ORCID больше не получает обновлений базы данных идентификаторов организаций RINGGOLD, используемой нашим реестром, и мы не сможем обрабатывать или использовать идентификаторы RINGGOLD, созданные после этой даты. Посмотрите наш FAQ для получения дополнительной информации