Tutorial de API: Pesquisando o ORCID registro

Este tutorial descreve como pesquisar o ORCID Registro usando o ORCID API pública e membro. Ambos os métodos requerem um token de acesso recuperado usando suas credenciais de cliente.

O ESB ( ORCID API suporta a pesquisa de um subconjunto de ORCID metadados usando a sintaxe de consulta popular do Solr. Observe que apenas o ORCID iDis retornado nos resultados da pesquisa. Informações sobre como recuperar dados de um determinado ORCID iD pode ser encontrada em Leia os dados de um ORCID registro.

A pesquisa de API pode não ser adequada para seu uso. Você pode querer considerar estas alternativas:

• Encontrar um pesquisador ORCID eu ia? Não recomendamos a entrada manual de qualquer ORCID IDs em seus sistemas ou processos. Aconselhamos que você colete dados autenticados ORCID IDs de seus pesquisadores.
• ORCID libera um arquivo de dados públicos anual - um instantâneo de todos os dados públicos no ORCID Registro naquele momento - que também pode ser usado para realizar pesquisas em grandes dados públicos no Registro. Prêmio ORCID os membros também podem obter acesso ao arquivo de dados sob demanda usando o sincronização de dados públicos.
• Para obter instruções específicas sobre como encontrar um grande número de pesquisadores de sua instituição, consulte nosso dicas para encontrar ORCID detentores de registro em sua instituição

a

Por que devo atualizar ORCID registros?

Você pode ajudar a tornar a vida mais fácil para seus usuários conectando informações validadas a seus ORCID registros. Você também estará ajudando a construir confiança nas comunicações acadêmicas e, ao manter esses dados atualizados, poderá reduzir a carga de relatórios para seus usuários e melhorar a qualidade dos dados.

ORCID para organizações de pesquisa

Além de seu uso como um identificador persistente para seus pesquisadores, ORCID pode ajudá-lo a controlar como o nome de sua instituição é usado nos sistemas de pesquisa. Em combinação com outros identificadores persistentes ORCID permite que você afirme com autoridade sua equipe, corpo docente e afiliações de alunos com sua instituição. Você também pode usar ORCID APIs para receber notificações em tempo real sobre atividades de pesquisa, para atualizar formulários automaticamente e para acompanhar a carreira de seus ex-alunos.

ORCID para Organizações de Financiamento

Incorporando ORCID IDs em seus fluxos de trabalho de financiamento, você pode conectar de forma confiável seus financiados e programas de financiamento - e economizar tempo de todos e reduzir erros causados ​​pela digitação manual de informações. Usando ORCID em seu (s) sistema (s), você pode desempenhar sua parte na construção de uma infraestrutura de informações de pesquisa confiável, estabelecendo conexões entre os indivíduos e as bolsas que você lhes concedeu.

ORCID para editores

Os pesquisadores estão no centro de tudo o que os editores acadêmicos e de pesquisa fazem. As informações precisas do autor e do revisor são vitais para a indexação, pesquisa e descoberta, rastreamento de publicação, atribuição de financiamento e uso de recursos e apoio à revisão por pares.

ORCID serve como um centro de informações, permitindo que seus autores e revisores se conectem de forma confiável às suas contribuições e compartilhem informações de seus ORCID gravar conforme eles interagem com seus sistemas de publicação. A coleta de IDs para todos os seus autores e revisores durante o processo de publicação - seja para livros, periódicos, conjuntos de dados, composições, apresentações, códigos ou uma variedade de outros trabalhos - permite que as informações sejam facilmente compartilhadas, garante que os pesquisadores possam fornecer consentimento para compartilhar, economiza tempo e trabalho dos pesquisadores, reduz o risco de erros e, de forma crítica, permite que os pesquisadores recebam o crédito que merecem pelo importante trabalho que estão realizando.

Você achou este FAQ útil?

1

0

permalink

a

Como faço para coletar um ID autenticado?

Integração ORCID em seu sistema permite que sua organização colete dados autenticados ORCID IDs e adicione-os aos seus próprios dados. Ao mesmo tempo, o pesquisador fornece à organização permissão para ler e escrever de e para seus ORCID registro. 

Para fazer isso funcionar, as organizações DEVO obter autenticado ORCID IDs usando o ORCID API OAuth. Isso significa que eles incluem um ORCID botão ou link da marca em seu sistema que, quando clicado, solicita ao usuário que faça login em seu ORCID registro.

Uma vez logado, o usuário será solicitado a autorizar o acesso ao sistema solicitando seu ORCID iD

O usuário ORCID iD e nome no ORCID O registro (dependendo das configurações de visibilidade) é devolvido à organização como parte deste processo. O sistema pode então solicitar dados adicionais do ORCID API.

O fluxo de trabalho descrito acima para coletar APIs autenticadas está disponível em ambos ORCIDAPIs públicas e de membros. O primeiro está disponível para utilização gratuita por serviços não comerciais.

Você achou este FAQ útil?

5

0

permalink

Obtenha um token de pesquisa

Qualquer pessoa com credenciais de API pode pesquisar o ORCID Registro. A API membro requer um / read-public token de acesso para fazer chamadas de API. Para obter um token, faça uma chamada para o ORCID API usando autorização OAuth de duas pernas (ou seja, uma chamada direta para a API). A chamada é a mesma para credenciais de API públicas e membros.

a

Como obtenho o token de acesso “/ read-public”?

Qualquer pessoa com credenciais de API públicas ou de membro pode receber um / read-public token de acesso. Para obter um token, você faz uma chamada para o ORCID Ponto de extremidade do token da API.

Esse processo geralmente é conhecido como fluxo OAuth de credenciais do cliente ou OAuth de 2 etapas.

Um exemplo de chamada para obter um token de acesso para ler dados públicos na sandbox - substitua os espaços reservados por suas credenciais (certifique-se de remover os colchetes.

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

Em seguida, você receberá um token de acesso semelhante ao seguinte. O token retornado é de longa duração (não expira por aproximadamente 20 anos) e pode ser usado várias vezes para recuperar dados públicos de ORCID Registros. 

{"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}

Nota: Todos os tokens com o escopo / authenticate agora também têm o escopo / read-public incluído. Se você usar apenas o escopo / authenticate, poderá usar os tokens de acesso armazenados para ler dados públicos sem precisar obter novamente um token de acesso. 

Integradores que usam a API membro podem usar o / read-public escopo para ler ORCID registrar resumos.

Você achou este FAQ útil?

4

35

permalink

Pesquisas básicas baseadas em palavras-chave

As pesquisas podem ser realizadas no registro de teste de sandbox ou no registro de produção ao vivo. O endpoint da API de pesquisa aceita GET para solicitações HTTP. A única entrada necessária é a string de consulta que é passada para o mecanismo de pesquisa Solr. 

a

Como uso o ORCID API de pesquisa?

O ESB ( ORCID a API de pesquisa usa a sintaxe SOLR. Todas as sintaxes de consulta disponíveis em SOLR 3.6 são suportadas, incluindo Lucene com extensões Solr (Padrão), DisMax e Extended Dismax.

Você precisa de um token de acesso “/ read-public” para usá-lo. Depois de obter seu token de pesquisa, crie seu URL de pesquisa de base:

Tipo de credencial:	API pública	API de membro
URL do recurso:	Caixa de areia: https://pub.sandbox.orcid.org Produção: https://pub.orcid.org	Caixa de areia: https://api.sandbox.orcid.org Produção: https://api.orcid.org
Versão API:	v3.0
Ponto final de pesquisa	/ search /? = [consulta]

Um exemplo de chamada para pesquisar por “orcid” com o token na API pública do sandbox com os resultados retornados no formato 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

Os resultados irão especificar o número de resultados encontrados (num-found) e exibir os primeiros 1000 resultados por padrão:

 <?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> 

Um exemplo de pesquisa básica na API pública do sandbox com resultados retornados no formato 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

A pesquisa retorna apenas o indivíduo ORCID IDs de registros contendo dados públicos correspondentes à pesquisa. Para obter mais informações sobre o resultado, faça uma chamada para ler o ORCID gravar diretamente.

Para mais informações, consulte as nossas Tutorial de API de pesquisa.

Você achou este FAQ útil?

1

3

permalink

Pesquisa Expandida

Além da pesquisa básica, o ponto final da pesquisa expandida pesquisa expandida está disponível. O uso deste endpoint retorna as seguintes informações: orcid-id, nomes próprios, nomes de família, nomes de crédito, outros nomes, email e instituição ao usar a sintaxe de pesquisa padrão. Os resultados podem ser retornados em XML ou JSON.

Um exemplo de pesquisa na API pública da sandbox para o termo “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>

Resultados da pesquisa retornados em formato CSV

Os resultados da pesquisa também podem ser retornados no formato CSV. Como parte da chamada, você pode especificar as colunas de saída de uma lista de campos disponíveis abaixo:

•  orcídio
•  email
•  nome dado
•  sobrenome
•  nomes próprios e de família
•  nome de crédito
•  outro nome
•  nome-da-instituição-afiliação-atual
•  nome-da-instituição-anterior 

Usando suas credenciais, você precisa especificar o cabeçalho como 'text / csv '. Como parte da chamada de pesquisa, você também precisa adicionar à consulta os campos necessários na saída.  

Um exemplo de chamada para um membro pesquisando um ID* ringgold com a saída necessária incluindo ORCID, nome e afiliação. 

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,'

Você também pode completar a pesquisa usando seu navegador. O URL é construído da mesma maneira, mas você não precisa usar nenhuma credencial de API. Observe que isso só pode ser concluído usando a API pública. 

Uma nota sobre aspas ou marcas de discurso.

Ao pesquisar no navegador, use aspas retas como estas: "" ao realizar pesquisas e não aspas curvas como estas: “”. Usar aspas curvas fornecerá resultados incorretos.

Abaixo está um exemplo de chamada usando a API pública pesquisando pelo nome da organização com o ORCID, nomes próprios, sobrenomes, nome de afiliação da instituição atual e nome de afiliação da instituição anterior como a saída desejada. 

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

Abaixo está outro exemplo de chamada usando a API pública procurando por diferentes variações do nome da organização.

https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:(“University of Plymouth” OR “Plymouth University”)

Formatando consultas de pesquisa

O comportamento padrão é uma pesquisa de formato livre e irrestrita em todos os campos indexados disponíveis. Uma pesquisa básica por “newman”, portanto, resultará em pesquisadores com o nome publicado Newman, nome dado Newman ou associado a uma obra com “newman” no título, etc. As pesquisas podem ser retornadas em json ou xml com base no que é especificado no tipo de conteúdo.

A API também oferece suporte a pesquisas booleanas usando várias palavras-chave, frases exatas e outros recursos de pesquisa booleana. Palavras-chave devem ser combinadas usando colchetes e “AND” ou “OR” em maiúsculas - minúsculas “e” e “ou” são tratados como parte da pesquisa.

Um exemplo de pesquisa booleana na API pública do sandbox para registros que correspondem a três palavras-chave (johnson, cardiology e houston):

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+AND+cardiology+AND+houston

Um exemplo de pesquisa booleana na API pública do sandbox para registros que correspondem à palavra-chave “johnson” e à palavra-chave “caltech” ou a frase “California Institute of Technology” e os resultados retornados em XML:

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+AND+(caltech+OR+"California+Institute+of+Technology")

Pesquise por elementos específicos por campo

Você pode usar uma pesquisa por campo quando precisar pesquisar uma seção específica do ORCID registro.

A sintaxe básica para pesquisa em campo é field: value, então a string de consulta family-name: james encontrará registro com o sobrenome “James”, como “Roland James”, mas não aqueles com o primeiro nome “James”, como como “James Johnson”.

Vários campos: pares de valores podem ser fornecidos. A correspondência é baseada em tokens de substring em vez de strings brutas, portanto, a string de consulta other-names: carberry corresponderá a J. Carberry e JS Carberry.

a

Quais campos o ORCID Suporte para API de pesquisa?

O ESB ( ORCID a API de pesquisa usa a sintaxe SOLR. Todas as sintaxes de consulta disponíveis em SOLR 3.6 são suportadas, incluindo Lucene com extensões Solr (Padrão), DisMax e Extended Dismax.

Você pode usar uma pesquisa por campo quando precisar pesquisar uma seção específica do ORCID registro. A lista atual de campos reconhecidos na pesquisa da API, junto com seus elementos de estrutura de registro correspondentes, são os seguintes:

Campo de pesquisa	Descrição
Dados biográficos
recebem nomes	O (s) nome (s) fornecido (s) do usuário.
sobrenome	O nome de família (sur) do usuário.
nome de crédito	O “nome publicado” no ORCID interface do usuário, o nome que normalmente aparece nas publicações do usuário
outros nomes	Nomes alternativos que podem ter aparecido nas publicações do usuário.
email	O endereço de e-mail do usuário.
palavra chave	Qualquer palavra-chave associada ao usuário.
referência de identificação externa	Identificadores de outros sistemas adicionados ao usuário ORCID gravar usando a API.
Dados de afiliações
nome da organização de afiliação	O nome de qualquer organização em um item de educação ou emprego no registro do usuário.
grade-org-id	O ESB ( ID DE GRADE de qualquer organização na seção de atividades do registro do usuário. Geralmente, isso será associado a um item de educação ou emprego.
ror-org-id	O ESB ( ID ROR de qualquer organização na seção de atividades do registro do usuário. Geralmente, isso será associado a um item de educação ou emprego.
ringgold-org-id	O ESB ( ID do anel de ouro* de qualquer organização na seção de atividades do cadastro do usuário. Geralmente isso estará associado a um item de educação ou emprego.
Dados de financiamento
títulos de financiamento	O título de qualquer item de financiamento no registro do usuário.
Fundref-Org-Id	O ESB ( ID de registro do financiador Crossref de qualquer organização na seção de atividades do registro de um usuário. Geralmente, isso estará associado a um item de financiamento, mas também pode estar associado a uma afiliação.
números de concessão	Número de concessão (identificador) de qualquer item de financiamento no registro do usuário.
Dados de atividades de pesquisa
títulos de trabalho	Os títulos de qualquer trabalho no registro do usuário.
IDs de objetos digitais	Um identificador externo de trabalho com o tipo doi
faça você mesmo	Um identificador externo de trabalho com o tipo doi e o relacionamento do identificador externo definido como self
[tipo de identificador externo] *	Um identificador externo de trabalho com o tipo fornecido
[tipo de identificador externo] * - próprio	Um identificador externo de trabalho com o tipo fornecido e o relacionamento do identificador externo definido como self
[tipo de identificador externo] * - parte de	Um identificador externo de trabalho com o tipo fornecido e o relacionamento do identificador externo definido como parte de
[tipo de identificador externo] * - versão de	Um identificador externo de trabalho com o tipo fornecido e o relacionamento do identificador externo definido para a versão de * Para obter uma lista completa de identificadores externos, consulte o lista de identificadores. Alguns identificadores podem exigir “-self”, “-part-of” ou “-version-of” para retornar resultados
ORCID dados de registro
orcídio	Os 16 dígitos ORCID identificador do usuário, no formato 0000-0001-2345-6789.
data de envio do perfil	A data e hora em que o registro foi criado.
data da última modificação do perfil	A data e hora em que o registro foi modificado pela última vez.
Todos os dados
texto	Todos os campos acima. Este também é o campo padrão para consultas de sintaxe Lucene.

veja nossa Tutorial de API de pesquisa para entender melhor.

*Embora os identificadores Ringgold ainda existam dentro do ORCID registro, a partir de 1º de agosto de 2023, ORCID não receberá mais atualizações do banco de dados de identificadores de organização RINGGOLD usado por nosso Registro, nem poderemos processar ou usar IDs RINGGOLD criados após essa data. Veja nosso Perguntas frequentes para mais informações

Você achou este FAQ útil?

1

1

permalink

Paginação do resultado da pesquisa

A API retorna 1000 resultados (ou linhas) por padrão na API pública e membro. Para exibir um certo número de uma vez ou para recuperar após os primeiros 1000 resultados, adicione parâmetros para o ponto inicial e o número de resultados. O número máximo de resultados que podem ser retornados de uma vez também é 1000.

Um exemplo de pesquisa na API pública do sandbox para os segundos 1000 resultados correspondentes à palavra-chave “orcid”:

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=orcid&start=1000&rows=1000

Um exemplo de pesquisa na API pública do sandbox para os itens 2 a 4 em uma pesquisa com os termos “johnson”, “cardiologia” e “houston”:

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+cardiology+houston&start=2&rows=3

Consultas de exemplo usando a API pública

Exemplo 1

Pesquise sobrenomes de todos ORCID registros para o nome “Sanchez”

Exemplo 2

Pesquisar todos os campos pesquisáveis ​​de todos ORCID registros para a palavra “inglês”

Exemplo 3

Procure colaboradores associados ao trabalho no PubMed ID 2485-7732

Exemplo 4

Pesquise os registros com o sobrenome “Einstein” e a palavra-chave “Relatividade”. Somente registros contendo o sobrenome e a palavra-chave serão retornados.

Exemplo 5

Pesquise os registros com o sobrenome Taylor e o prenome Michael.

Exemplo 6

Pesquise nomes próprios e sobrenomes de todos ORCID registros para “Raymond”, mas aumentam o nome de família. Registros com nomes próprios contendo “Raymond” e sobrenome contendo “Raymond” serão devolvidos, mas aqueles com sobrenome aparecerão no topo da lista e terão uma pontuação de relevância mais alta.

Exemplo 7

Pesquise nomes próprios e sobrenomes de todos ORCID registros para “Raymond”, mas aumentam o nome de família. Registros com nomes próprios contendo "Raymond" e nome de família contendo "Raymond" serão devolvidos, mas aqueles com nome de família aparecerão no topo da lista e terão uma pontuação de relevância mais alta. Os dois registros com ORCID Os IDs https://sandbox.orcid.org/0000-0002-0879-455X e https://sandbox.orcid.org/0000-0001-6238-4490 serão excluídos dos resultados.

Exemplo 8

Procure por registros com o DOI 10.1087 / 20120404 exato definido como self

Exemplo 9

Procure por registros com um DOI que inclua 10.1087 definido como próprio ou parte de

Exemplo 10

Procure por registros com um identificador PubMed 27281629 definido como self

Exemplo 11

Procure por registros com um identificador ISBN, incluindo 1234 definido como próprio ou parte de

Exemplo 12

Pesquise todos os registros com um endereço de e-mail com domínio @orcid.org

Exemplo 13

Pesquise os registros modificados entre 1º de janeiro de 2017 e hoje

Exemplo 14

Pesquise os registros afiliados à organização com o nome exato “Boston University” ou “BU”

Exemplo 15

Pesquise registros afiliados ao Ringgold ID* 1438 (University of California Berkeley) com formato CSV

Exemplo 16

Pesquise registros afiliados ao GRID ID grid.5509.9 (Universidade de Tampere) usando a pesquisa expandida

* Embora ainda existam identificadores Ringgold dentro do ORCID registro, a partir de 1º de agosto de 2023, ORCID não receberá mais atualizações do banco de dados de identificadores de organização RINGGOLD usado por nosso Registro, nem poderemos processar ou usar IDs RINGGOLD criados após essa data. Veja nosso Perguntas frequentes para mais informações