В этом интервью Роб Питерс, ORCIDДиректор по технологиям, представляет ORCIDновый API - запущен 14 февраля 2017 г.
Прежде чем мы начнем говорить о новом API, не могли бы вы рассказать нам немного о ORCIDТехническая группа и ваша роль директора?
На первый взгляд, ORCID команда очень похожа на любую другую техническую команду. У нас пять разработчиков, администратор сервера, аналитик по обеспечению качества и, конечно же, менеджер (я). Тем не менее, что интересно, так это наши разные географические, культурные и профессиональные особенности. Трое из нас находятся в США, трое - в Коста-Рике и двое - в Великобритании, поэтому географически мы получаем много перспектив. Кроме того, некоторые из нас занимаются традиционным консультированием по программному обеспечению, другие - представителями издательской индустрии, стартапов «Кремниевой долины» и библиотечного дела.
Моя личная роль в качестве директора по технологиям - управление повседневной разработкой программного обеспечения. Это сводится к тому, чтобы помочь моей команде общаться друг с другом и остальной частью организации, а также управлять тем, какие задачи команда берет на себя (а какие откладывает). У меня также есть возможность активно участвовать в принятии стратегических решений на более высоком уровне. ORCID делает.
Переход на API версии 2.0 - почему мы - ORCID, А также ORCID сообщество - нужно это обновление?
Первый ORCID API, запущенный в октябре 2012 года, неизбежно основывался на многих предположениях, которые позже оказались ошибочными и / или потребовали доработки. Чтобы лучше служить исследовательскому сообществу, мы должны постоянно проверять эти предположения. Использование отзывов, вопросы и изучение доказательств, которых не было до запуска, дало нам новое понимание того, что ORCID API должно и не должно быть. Как вы увидите из моего ответа на следующий вопрос, версия 2.0 представляет собой серьезный отход от предположений, на которых была основана 1.0, но при этом достаточно прагматична, чтобы обеспечить преемственность между двумя API.
Каковы основные различия между 1.2 и 2.0 и какую пользу они принесут участникам?
При разработке 2.0 мы хотели устранить препятствия, с которыми участники столкнулись с версией 1.2, а также представить новые функции, которые, как мы знаем, нужны сообществу.
Таким образом, помимо решения известных проблем, таких как масштабируемость при управлении гиперавторскими публикациями и проблем с неявным поведением, которые вызывали путаницу для участников, мы также добавили новые функции для поддержки распознавания экспертных оценок, улучшенные уведомления для пользователей и возможность поддерживать практически любой постоянный идентификатор.
Чтобы объяснить, почему потребовались некоторые из этих изменений, я собираюсь перейти к техническим аспектам. Прежде чем приступить к кодированию одной новой строки, мы составили список вещей, которые мы хотели бы улучшить, со следующим «манифестом»:
- Перестань думать о ORCID запись как монолитный (большой единичный) документ. Несколько учреждений пишут в ORCID запись означает распознавание записи многоквартирные дома. Кроме того, исследователи часто проводят такие огромные объемы исследований, что даже их резюме не умещаются в монолитном документе.
- Упрощенные области видимости. Гранулярность областей разрешений в 1.0 API ошеломляет для всех вовлеченных сторон; их упрощение облегчит жизнь как разработчикам, так и пользователям.
- Явный RESTful поведение. Неявное поведение плохо для разработчиков, поскольку приводит к неожиданному поведению, которое, в свою очередь, сбивает с толку конечных пользователей. Благодаря поведению RESTful наш новый API позволяет избежать этих проблем.
- Кратчайшие разумные URL-адреса. Хорошим примером может быть / works / 1234 лучше, чем /orcid-работы / 1234.
- Звонки в список возвращают только сводки. Чтобы ускорить вызов записи, API 2.0 возвращает только сводки для списков. Выполнение одного запроса для каждой части информации об исследователе не работает для гиперавторских статей, в которых есть десятки, сотни или даже тысячи авторов.
- Общие имена и структуры для общих элементов. 2.0 позволяет нам гарантировать, что общие элементы в XML / JSON имеют одинаковые имена.
- коды ошибок. Теперь мы включаем коды ошибок в тело ответа, когда ошибка не полностью описывается стандартным кодом HTTP.
И какие преимущества для пользователей?
В конце концов, API должен быть безупречным для пользователей. Неожиданное поведение 1.0 возникает и влияет на работу пользователя, в то же время расстраивая разработчиков, реализующих API. На практическом уровне новый API позволяет оптимизировать каждый раздел в ORCID запись для согласованного применения настроек видимости, источника и даты создания для элементов в каждом разделе.
Повлияет ли это и на общедоступный API? Как?
Да. Изменения в членском API и общедоступном API всегда идут в ногу со временем. Хотя мы ценим поддержку членов и полагаемся на нее, мы также привержены нашему более широкому видению «мира, в котором все, кто участвует в исследованиях, стипендиях и инновациях, уникально идентифицированы и связаны со своим вкладом в разных дисциплинах, границах и времени». Мы рассматриваем общедоступный API как средство достижения этой цели.
Как вы думаете, что станет основными проблемами при развертывании новой версии и какая поддержка будет ORCID обеспечивать?
Самая сложная проблема - выделить ресурсы для работы по модернизация. Для некоторых организаций это может быть всего несколько дней, а для других может потребоваться целый месяц. Независимо от временных рамок, не бойтесь обращаться за помощью и просить о помощи, даже если у вас есть небольшая деталь, которая мешает вашему прогрессу. Полная документация теперь доступен для участников.orcid.org и ORCID членские организации также могут Контакты. Размещение в Форум пользователей API может быть полезным, добавляя комментарии со всех концов ORCID сообщество. Я также твердо верю в прямую доступность, так что не стесняйтесь напишите мне напрямую.
Кто в настоящее время использует API 2.0 и какие отзывы они предоставили?
Мы прилагаем много усилий, чтобы сделать релиз-кандидаты доступными, чтобы получить обратную связь. CrossRef, Datacite, CERN и PTCRIS - это лишь некоторые из ORCID участники, которые реализовали релиз-кандидат и предоставили отзывы. Кроме того, несколько организаций реализовали функциональные возможности экспертной оценки с использованием 2.0, в том числе первые участники, Американский геофизический союз, F1000 и Publons. Отзывы включали обычные предложения технических специалистов, такие как имена, используемые в схеме, именование конечных точек или дискуссии об эффективности. Подобные детали могут иметь большое значение для участников. Однако разработчики релизов-кандидатов также предоставляют обратную связь с точки зрения исследователя, что мы считаем бесценным.
Как долго будет ORCID продолжать поддерживать старый API?
Мы планируем завершить 1.2 в конце 2017 года. Независимо от даты заката, если вы согласны с ORCIDмиссия и заботятся об исследователях, с которыми взаимодействуют ORCID вы захотите перейти на 2.0 сейчас.
Что еще нам следует знать об этом изменении?
Мы надеемся, что 2.0 окажется долговечным, и мы можем сосредоточиться на других частях ORCID стек технологий на долгое время!
Для забавного и удобного обзора функций API 2.0 см. слайд-колода!