Fazemos o possível para fornecer mensagens de erro descritivas em nosso Registro e API. Aqui estão algumas dicas para ajudá-lo com quaisquer erros que você possa encontrar.
Erros API
Nossos códigos de erro de API incluem mensagens descritivas que devem ser facilmente compreensíveis.
Uma lista de códigos de erro comuns de API, seus possíveis significados e dicas sobre como solucioná-los está disponível em nosso documentação técnica.
Se você não conseguir resolver o problema que está enfrentando, informe-nos.
Erros de formatação XML / JSON
Se você está tendo problemas com a formatação dos dados, está tentando adicionar ou atualizar em um ORCID registro, recomendamos consultar exemplos por:
- Enviando uma chamada para ler o registro ou item individual para receber XML / JSON de exemplo ou, se você estiver atualizando um registro, o XML / JSON completo para o item que você está atualizando e use isso como seu ponto de partida
- Consultando nosso arquivos XML e JSON de amostra em nosso repositório GitHub - temos XML / JSON limpo para postagem e XML / JSON completo para exemplos de leitura
Antes de adicionar um item ao ORCID registro, você precisará formatar seus dados no ORCID esquema. Formate seus dados no ORCID esquema de mensagem em XML ou JSON.
Nosso repositório GitHub contém recursos que ajudarão na formatação ao criar novos itens no ORCID registro, e ao ler itens existentes no ORCID registro:
observe que diferentes versões da API têm diferentes formatos de mensagem. Esquemas e exemplos da versão 2.0 e 2.1 também estão disponíveis.
Mais exemplos podem ser facilmente encontrados lendo os metadados de um registro bem preenchido.
Erros de escopo
Se estiver recebendo erros relacionados a escopos, recomendamos que você:
- Verifique se você não está usando escopos de membro com um cliente API público.
- Se estiver adicionando, atualizando ou lendo dados de visibilidade limitada, você tem os escopos corretos para executar a ação.
- Verifique se você não está solicitando escopos de duas etapas usando OAuth de três etapas e vice-versa.
Ao solicitar permissão para interagir com um ORCID registro do usuário, você especifica um ou mais 'escopos'. Cada escopo permite que você faça certas coisas, como ler o registro ou atualizar uma seção específica.
Escopos de três pernas (código de autorização)
3 pernas refere-se aos três atores envolvidos na obtenção de permissão de um usuário; ORCID, seu sistema e o próprio usuário.
/autenticar
Este escopo é usado para coletar o ORCID iD e ler informações públicas apenas no registro. Todos os outros escopos de três pernas incluem a permissão de autenticação, portanto, esse escopo pode ser omitido se for solicitado qualquer outro acesso. Este escopo está disponível na API de membros ou pública.
/ read-limited (Member API apenas)
Este escopo é usado para obter acesso para ler itens públicos e de visibilidade limitada em um ORCID registro. Este escopo está disponível apenas na API de membros.
/ atividades / atualização (apenas API de membro)
Este escopo é usado para escrever, atualizar e excluir itens nas seções de afiliação, financiamento, trabalhos, atividades profissionais, recursos de pesquisa e revisão por pares de um ORCID registro. Este escopo está disponível apenas na API de membros.
/ pessoa / atualização (apenas API de membro)
Este escopo é usado para escrever, atualizar e excluir itens nas seções de outros nomes, palavras-chave, países, urls de pesquisador, sites e identificadores pessoais externos do registro. Este escopo está disponível apenas na API de membros.
código aberto
Este escopo é usado por integradores OpenID quando um id_token é necessário. Quando o escopo openid é incluído, o Registro retorna um id_token dentro da resposta do token e concede ao cliente permissão para acessar o endpoint de informações do usuário para aquele usuário. Este escopo está disponível na API pública e membro.
Observe que o escopo 'openid' não começa com '/' como o outro ORCID Escopos de API. Isso ocorre porque o escopo 'openid' não é definido por ORCID, mas em vez disso definido pela especificação OpenID Connect. Por favor, veja nosso Documentação OpenID para obter mais informações.
Múltiplos escopos
Vários escopos podem ser solicitados em uma única interação, listando os escopos no URL de autenticação com um espaço codificado entre cada um, como escopo = / leitura limitada% 20 / atividades / atualização% 20 / pessoa / atualização
Acesso completo
Se você deseja acesso total para ler e editar um registro, inclua três escopos em seu URL de autenticação: / read-limited, / Activities / update e / person / update. No URL, eles apareceriam como escopo = / leitura limitada% 20 / atividades / atualização% 20 / pessoa / atualização
Escopos de duas pernas (credencial do cliente)
Para algumas atividades, você não precisa pedir permissão ao usuário. Escopos OAuth de duas pernas são solicitados diretamente do ORCID API e não exigem que o pesquisador conceda permissão. Tokens com esses escopos são válidos por 20 anos e podem ser reutilizados
/ read-public
Este escopo é usado para ler informações públicas em um único ORCID identificação, procure por ORCID registros ou para ler informações resumidas (somente API para membros). Este escopo está disponível na API Membro ou Pública.
/ webhook
Este escopo permite que um aplicativo cliente registre um webhook em um ORCID registro, a fim de receber notificações quando um registro é atualizado. Este escopo está disponível para premium ORCID apenas membros.
Existem dois âmbitos de atualização diferentes - um para detalhes biográficos e outro para atividades.
Objetivo | Descrição | Endpoints API |
/ pessoa / atualização | Dados biográficos - a coluna da esquerda do ORCID interface de usuário de registro. | /Morada / external-identifiers /palavras-chave /outros nomes / researcher-urls |
/ atividades / atualização | Dados da atividade de pesquisa - a coluna direita da ORCID interface de usuário de registro. | /distinção / distinções /Educação / educations /emprego / empregos /financiamento / fundings / posição-convidado / convidados-posições /Filiação / membros / peer-review / peer-reviews /qualificação / qualifications / research-resource / research-resources /serviço /Serviços /trabalhos /trabalho |
Mensagens de erro de registro
Geralmente, seus usuários encontrarão apenas alguns erros relacionados à API ao autorizar uma conexão com seu aplicativo:
URI de redirecionamento ruim
O URI de redirecionamento não corresponde aos URIs de redirecionamento registrados.
Essa mensagem de erro é uma indicação de que seu link de autorização especifica um URI de redirecionamento que você não registrou nas credenciais do cliente API. Se você estiver usando a API pública, você mesmo pode corrigir isso em seu Ferramentas de desenvolvimento. Se você estiver usando a API de membro, precisará solicitar o ORCID Equipe de engajamento para atualizar suas credenciais.
Link inválido para o formulário de autorização OAuth
A página solicitada não pode ser encontrada. Se você tem esta página marcada, por favor, apague-a. Se você seguiu um link, por favor denuncie.
Este erro tende a ocorrer quando o link de autorização OAuth é formado incorretamente, por exemplo https://orcid.org/signin/oauth/authorize?[….] em vez de https://orcid.org/oauth/authorize?[…]. Para resolver, basta corrigir o link.
Mensagem não descritiva
Ocorreu um problema com o servidor. Se o problema persistir, entre em contato com o suporte.
Este erro ocorre com mais freqüência quando nenhum escopo é especificado. Você deve incluir um escopo no link de autorização OAuth; o escopo mínimo é / authenticate.
Verifique se ORCID está funcionando!
É muito, muito raro, mas se você acha que o erro é um problema com o ORCID Servidores que você pode verificar http://status.orcid.org/
Observe que o ORCID O Sandbox não tem um contrato de nível de serviço e pode ficar inativo por períodos de 20 minutos quando estamos lançando atualizações de código.
Conseguindo ajuda
Estamos sempre dispostos a ajudar! ORCID organizações membros podem obter apoio de ORCID diretamente.
Todos os integradores também são incentivados a aderir ao ORCID Grupo de usuários API, onde você pode se comunicar com outros integradores e usuários de API, bem como o ORCID .