Мы делаем все возможное, чтобы предоставлять описательные сообщения об ошибках в нашем реестре и API. Вот несколько советов, которые помогут вам с любыми ошибками, с которыми вы можете столкнуться.
Ошибки API
Наши коды ошибок API включают описательные сообщения, которые должны быть легко понятными.
Список распространенных кодов ошибок API, их возможные значения и советы по их устранению доступны в нашем техническая документация.
Если вы не можете решить возникшую проблему, сообщите нам об этом.
0
0
Ошибки форматирования XML / JSON
Если у вас возникли проблемы с форматированием данных, которые вы пытаетесь добавить или обновить на ORCID записи, мы рекомендуем ознакомиться с примерами:
- Отправка вызова для чтения записи или отдельного элемента для получения примера XML / JSON или, если вы обновляете запись, полного XML / JSON для элемента, который вы обновляете, и используйте это в качестве отправной точки
- Консультации наших образцы файлов XML и JSON в нашем репозитории GitHub - у нас есть как чистый XML / JSON для публикации, так и полный XML / JSON для чтения примеров
Прежде чем вы сможете добавить элемент в ORCID запись, вам нужно будет отформатировать ваши данные в ORCID схема. Отформатируйте данные в ORCID схема сообщения в XML или JSON.
Наш репозиторий GitHub содержит ресурсы, которые помогут с форматированием при создании новых элементов на ORCID записи, а при чтении существующих элементов на ORCID запись:
обратите внимание, что разные версии API имеют разные форматы сообщений. Также доступны схемы и примеры версий 2.0 и 2.1..
Дополнительные примеры можно легко найти, прочитав метаданные хорошо заполненной записи.
0
0
Ошибки в области видимости
Если вы получаете ошибки, связанные с областями, мы рекомендуем вам:
- Убедитесь, что вы не используете области участников с общедоступным клиентом API.
- Если вы добавляете, обновляете или читаете данные ограниченной видимости, у вас есть правильные области действия для выполнения действия.
- Убедитесь, что вы не запрашиваете двухсторонние области с использованием трехстороннего протокола OAuth и наоборот.
При запросе разрешения на взаимодействие с 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
4
Существует два разных объема обновлений: один для биографических данных, а другой - для мероприятий.
| Объем | Описание | Конечные точки API |
| / человек / обновление | Биографические данные — левая колонка ORCID запись пользовательского интерфейса. | /адрес / внешние идентификаторы / ключевые слова /Другие названия / исследователь-urls |
| / действия / обновление | Данные об исследовательской деятельности — правая колонка ORCID запись пользовательского интерфейса. | /различие / различия /образование / образование /работа / вакансии / финансирование / финансирование / приглашенная позиция / приглашенные должности / членство / членство / peer-review / peer-reviews /квалификация / квалификация / research-ресурс / исследования-ресурсы /служба /Сервисы /Работа /работает |
3
7
Сообщения об ошибках реестра
Как правило, при авторизации соединения с вашим приложением пользователи сталкиваются с несколькими ошибками, связанными с API:
Неверный URI перенаправления
URI перенаправления не соответствует вашим зарегистрированным URI перенаправления.
Это сообщение об ошибке указывает на то, что ваша ссылка для авторизации указывает URI перенаправления, который вы не зарегистрировали в своих учетных данных клиента API. Если вы используете общедоступный API, вы можете исправить это самостоятельно в своем Инструменты разработчика. Если вы используете API участников, вам нужно будет запросить ORCID Команда по взаимодействию для обновления ваших учетных данных.
Запрошенная страница не может быть найдена. Если у вас есть эта страница в закладках, удалите ее. Если вы перешли по ссылке, сообщите об этом.
Эта ошибка обычно возникает, когда ссылка для авторизации OAuth сформирована неправильно, например https://orcid.org/signin/oauth/authorize?[….] вместо https://orcid.org/oauth/authorize?[…]. Для разрешения просто исправьте ссылку.
Неописательное сообщение
Возникла проблема с сервером. Если проблема не исчезнет, обратитесь в службу поддержки.
Эта ошибка чаще всего возникает, когда не указана область действия. Вы должны включить область в ссылку авторизации OAuth; минимальная область действия - / аутентифицировать.
Проверить, если ORCID работает!
Это очень и очень редко, но если вы считаете, что ошибка связана с ORCID Сервера, на которых вы можете проверить http://status.orcid.org/
Обратите внимание, что ORCID Sandbox не имеет соглашения об уровне обслуживания и может не работать в течение 20 минут, когда мы выпускаем обновления кода.
Получение справки
Мы всегда рады помочь! ORCID членские организации могут получить поддержка от ORCID непосредственно.
Всем интеграторам также предлагается присоединиться к ORCID Группа пользователей API, где вы можете общаться с другими интеграторами и пользователями API, а также с ORCID .