ORCID предлагает несколько API, которые позволяют вашим системам подключаться к ORCID реестр, включая чтение и запись в ORCID записи. Некоторые функции API доступны всем бесплатно (Публичный API); другие доступны только для ORCID членские организации (API для членов и премиум-членов). Любой желающий может бесплатно протестировать любой из наших API-интерфейсов на нашем тестовом сервере в песочнице.
Прежде чем ты начнешь
Когда вы приступаете к планированию интеграции, вам следует учесть:
- Что вы хотите сделать с ORCID API - посетите наш Рабочие процессы и лучшие практики интеграции, Если вы ORCID организации-члена, вы можете обратиться за помощью к нам или руководителю вашего консорциума! .
- Используете ли вы систему, которая уже поддерживает ORCID. Если да, то это может быть так же просто, как настроить вашу систему для работы с ORCID. Пожалуйста, проверьте наш ORCID список сертифицированных поставщиков услуг чтобы узнать, включена ли ваша система
- Как вы будете общаться со своими исследователями о внедряемых изменениях, о том, что вам от них потребуется, о пользе для них и о том, что им нужно будет делать. Посетите наш Информационные ресурсы страница с идеями о том, как построить коммуникационную кампанию вокруг вашей новой интеграции. Также рекомендуем вам посмотреть наш вебинарЯ теперь участник и что?! Как говорить о ORCID"
Зарегистрируйтесь для получения учетных данных песочницы и создайте тест ORCID iD
Если вы создаете собственную интеграцию или используете приложение несертифицированного поставщика услуг, мы требуем, чтобы вы сначала использовали нашу тестовую среду для создания и тестирования вашей интеграции.
Вы можете запросить учетные данные 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. Мы рекомендуем вам ознакомиться с принципами работы этой службы и ее ограничениями, прежде чем использовать эти адреса.
6
8
Определите необходимые вам разрешения пользователя
Команда ORCID Member API можно использовать для чтения, добавления или обновления информации о пользовательском ORCID запись — вам просто нужно запросить разрешение у ваших исследователей.
При запросе разрешения на взаимодействие с 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 только для членов.
0
7
Убедитесь, что вы можете безопасно хранить данные
Важно, чтобы ваша система могла хранить информацию безопасным способом.
Интеграции должны хранить больше, чем просто ORCID записи. Ваша система должна будет уметь:
- Принять и хранить ORCID iDs: вашей системе необходимо знать iD ORCID запись для отображения iD и правильно обновиться. Сохраните его вместе с информацией исследователя, которая возвращается в ответе на обмен токенами. Мы рекомендуем хранить полный https URI: https://orcid.org/0000-0001-5727-2427.
- Принимать и хранить постоянные токены доступа и обновить токены: Токены доступа можно использовать для чтения и обновления записей, а также для обозначения того, что iD был аутентифицирован. Токены доступа действительны в течение примерно 20 лет или до тех пор, пока пользователь не отзовет их. Мы также рекомендуем хранить область действия токена, срок действия токена и обновить токены. При необходимости токены обновления можно использовать для создания новых токенов доступа с теми же или ограниченными областями действия. Храните данные токена доступа вместе с информацией исследователя.
- Принять и хранить поставить коды : Каждый элемент, который вы добавляете в ORCID Реестр будет возвращен с кодом размещения от ORCID API. Сохраните этот 6-значный код размещения вместе с элементом в вашей системе. С его помощью вы сможете определить, какой элемент необходимо прочитать, обновить или удалить.
- Предоставьте сообщения об ошибках и контакт в службу поддержки, если взаимодействие идет не так, как ожидалось.
0
0
Зарегистрируйтесь с ORCID команда или руководитель вашего консорциума, чтобы продемонстрировать, как работает ваше приложение.
Прежде чем ваша интеграция будет запущена на ORCID производственный реестр, наша группа по взаимодействию или руководитель вашего консорциума дважды проверят, что все, что вы создали в «песочнице», также будет работать в рабочей среде. Если вы используете ORCID В системе сертифицированного поставщика услуг этот шаг можно пропустить. У нас есть список минимальные требования эти требования необходимо выполнить, прежде чем мы сможем выдать учетные данные Member API Production.
Запрос членских организаций ORCID Учетные данные API участника на рабочем (рабочем) сервере, заполнив Форма клиентского приложения для API участников производства. Перед выдачей учетных данных API-интерфейса рабочего члена ORCID Аудиторская группа/Руководитель консорциума рассмотрит демонстрацию вашей интеграции в ORCID песочница. Это дает нам возможность увидеть великолепные интеграции, которые вы создали, и предложить улучшения рабочих процессов, а также проверить, соответствуют ли все интеграции нашим лучшим практикам и минимальным требованиям для запуска.
Чтобы предоставить демонстрацию вашей системы, вам необходимо настроить рабочую интеграцию с ORCID песочница, которая ORCID команда может просмотреть. Есть несколько способов поделиться своей рабочей интеграцией с песочницей:
- Рекомендуется: Живая демоверсия: Свяжитесь с нами, чтобы запланировать живую демонстрацию. Мы предоставим программное обеспечение для совещаний, которое позволит вам поделиться своим экраном, чтобы вы могли продемонстрировать свою интеграцию.
- Тестовый сайт: Если ваш сайт разработки общедоступен, отправьте нам URL вместе с тестовыми учетными данными (при необходимости) для доступа к вашей системе и инструкциями, описывающими, как использовать вашу систему ORCID Особенности. Предоставьте дополнительную документацию, чтобы проверить, что мы не сможем увидеть со стороны пользователя, например, используемую версию API, какие данные хранятся в вашей системе и т. Д.
- Скринкаст или скриншоты:Отправить запись или набор скриншотов с описаниями, четко объясняющими и демонстрирующими, как работает ваша интеграция на каждом этапе, включая то, что произойдет, если пользователь откажет в доступе или отключит свой идентификатор. Обязательно предоставьте дополнительную документацию, чтобы проверить все, что мы не сможем увидеть со стороны пользователя, например, используемую версию API и способ хранения данных.
1
0
Запрос членских организаций ORCID Учетные данные API участника на рабочем (рабочем) сервере, заполнив Форма клиентского приложения для API участников производства. Если вы используете систему поставщика, которая не входит в список ORCID Сертифицированные поставщики услуг, ваша интеграция должна будет пройти процесс проверки, чтобы гарантировать, что минимальные требования к интеграции и передовой опыт будут выполнены.
Вы можете связаться с вашим несертифицированным поставщиком услуг и получить доказательства непосредственно от них, что минимальные критерии соблюдены. Вам нужно будет отправить эти доказательства ORCID Команда по взаимодействию или руководитель вашего консорциума.
Есть несколько способов поделиться этими доказательствами:
- Скринкаст или скриншоты: Отправьте запись или набор снимков экрана с описаниями, четко объясняющими и демонстрирующими, как работает ваша интеграция на каждом этапе, включая то, что произойдет, если пользователь откажет в доступе или отключит свой iD. Обязательно предоставьте дополнительную документацию для проверки всего, что мы не сможем увидеть со стороны пользователя, например, используемую версию API и способ хранения данных.
- Общедоступная документация по интеграции: Отправьте общедоступную и актуальную ссылку, которая включает четкое описание того, как работает интеграция на каждом этапе. Как и в варианте 1, обязательно предоставьте дополнительную документацию для проверки всего, что мы не сможем увидеть со стороны пользователя, например, используемую версию API и способ хранения данных.
0
0
Запросить учетные данные API участника
Вы можете подать заявку на получение учетных данных API-интерфейса после того, как ваша интеграция будет рассмотрена ORCID команды или если вы используете ORCID сертифицированная система поставщика услуг.
Вам нужно будет заполнить форма для регистрации клиентского приложения. Ниже приведен краткий обзор требуемых полей:
Название организации: Ваш ORCID название членской организации
Основной контактный адрес электронной почты для учетных данных: Мы будем использовать этот адрес электронной почты, чтобы отправить вам учетные данные в зашифрованном виде по электронной почте, а также связаться с вами, если при вашей интеграции возникнут какие-либо вопросы или ошибки.
Дополнительный адрес электронной почты для пароля: адрес электронной почты, на который мы можем отправить ваш зашифрованный пароль электронной почты.
Имя вашего клиента: Это будет ваш ORCID название членской организации. Если у вас более одной интеграции, мы добавим приложение к имени.
URL домашней страницы вашего приложения: Отображается в виде ссылки в списке доверенных организаций среди пользователей. ORCID страница доверенных лиц. Это должна быть ссылка на вашу организацию или на главную страницу вашего приложения.
Краткое описание вашего клиентского приложения: этот текст будет отображаться на экране авторизации со значком вопросительного знака для ваших пользователей интеграции. Требуется краткое описание вашей интеграции.
URI перенаправления: Как только пользователь авторизует ваше приложение, он будет возвращен на указанный вами URI. Вы должны указать эти URI заранее, иначе ваши пользователи интеграции столкнутся с ошибкой.
- Принимаются только HTTPS URI.
- Зарегистрированные домены должны точно соответствовать используемым доменам, включая субдомены.
- Зарегистрируйте все URI перенаправления полностью, где это возможно.
- Требуется более 5 URI перенаправления? Укажите это в примечаниях к ORCID персонала.
Примечания для ORCID персонал: Используйте это поле, чтобы ORCID сотрудники знают что-либо дополнительное о вашем запросе или вашей интеграции
5
3
Перенесите ваше приложение в ORCID Реестр продукции
Получив учетные данные, вы готовы начать интеграцию. Если вы хотите протестировать свою интеграцию до того, как она будет опубликована, воспользуйтесь собственным тестировщиком. ORCID запись или коллега ORCID записи.
Запустите - и дайте всем знать
Запуск приложения - не последний шаг - вам нужно продолжать общаться со своими пользователями, чтобы они знали, что нужно подключать свои ORCID iD в вашу систему быстро и легко. Эффективная интеграция включает как технический компонент (который рассматривается в этом руководстве), так и социальный компонент. Исследователи должны быть проинформированы о том, что ORCID почему вы запрашиваете доступ к их ORCID запись, и что вы будете делать с их данными.
- Составьте график общения: убедитесь, что заинтересованные стороны знают о ваших ORCID проект задолго до запуска.
- Используйте сочетание нисходящего и восходящего коммуникаций.
- Продвигайте свой ORCID интеграция часто и для разных аудиторий.
- Создавайте локальные ресурсы для поддержки ваших пользователей, например, ответы на часто задаваемые вопросы, руководства по библиотекам, веб-страницы, учебные пособия и видео.
- Назначьте местного контактного лица для ORCID-связанные вопросы.
Если вам нужна помощь, обратитесь к своему руководителю по взаимодействию или руководителю консорциума.
Для поддержки социальной составляющей мы предлагаем инструментарий Информационные ресурсы чтобы помочь вам разработать кампанию в поддержку вашей интеграции и сообщить вашим исследователям:
- Что ORCID есть.
- Почему ваша система собирает iD и как ваша система будет выполнять задачи, например обновлять их записи.
- Почему ваши исследователи выиграют от создания ORCID iD и подключить их iD к вашей системе.
- Как ORCID приносит пользу более широкому глобальному исследовательскому сообществу.
Мы будем постоянно создавать эту «библиотеку» ресурсов на основе отзывов сообщества. Если у вас есть идея, что вы хотели бы увидеть, пожалуйста, свяжитесь с нами.
3
0