ORCID oferece uma API pública que permite que organizações que não são ORCID membros para conectar seus sistemas e aplicativos ao ORCID registro com comunicações máquina a máquina. A API é uma API tranquila e oferece suporte a XML e JSON.
A API pública pode ser usada para as seguintes funções:
- Faça login em seu sistema com ORCID
- Faça com que um usuário seja verificado ORCID iD
- Recupere dados públicos de um usuário ORCID registro
- Pesquisa pública ORCID dados de registro
Como faço para registrar um cliente API público?
Recomendamos que os desenvolvedores testem a API pública no servidor de teste sandbox antes de usar a versão de produção. Abaixo estão as etapas sobre como registrar-se para credenciais de API públicas nos ambientes Sandbox e Produção.
- Faça login na sua ORCID registro:
Servidor de produção: https://orcid.org/signin
Servidor de teste de sandbox: https://sandbox.orcid.org/signin - Clique no seu nome no canto superior direito
- Clique Ferramentas de desenvolvimento da opção do menu
Observação: Para acessar as Ferramentas do desenvolvedor, você deve verificar seu endereço de e-mail. Se você ainda não verificou seu endereço de e-mail, será solicitado que o faça neste momento. - Clique no botão “Cadastre-se gratuitamente ORCID botão público da API ”
- Revise e concorde com os termos de serviço quando solicitado.
Registre um aplicativo
- Depois de concordar com os termos de serviço, você será direcionado de volta às Ferramentas do desenvolvedor (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools) Preencha o formulário apresentado para registrar um novo aplicativo.
- Nome: O nome do seu aplicativo. Isso será exibido para os usuários quando eles concederem permissão ao seu aplicativo para obter seus ORCID iD, e será exibido em seu Lista de organizações confiáveis. Recomendamos usar o nome de sua organização ou serviço (por exemplo, o nome de um jornal).
- Website: O site que o usuário pode visitar para saber mais sobre seu aplicativo. Isso será exibido em seu Lista de organizações confiáveis.
- Descrição: Informações sobre o aplicativo que você está desenvolvendo e como usará as do usuário ORCID eu ia. Isso será exibido para os usuários na tela do OAuth.
- URIs de redirecionamento: URIs para uso com o protocolo OAuth 2.0 - esses são os locais para os quais seus usuários serão enviados após conceder a permissão de seu cliente para obter seus ORCID eu ia.
Os aplicativos de API públicos devem ter pelo menos um URI de redirecionamento registrado e o URI deve começar com https. Para testar, você pode adicionar automaticamente o URI do Google OAuth Playground clicando em “+ Google OAuth2 Playground” em Testar URIs de redirecionamento ou o ORCID Swagger de API pública clicando em “+ORCID interface public swagger ”.
Para mais informações, consulte Sobre redirecionar URIs. - Clique no ícone Salvar na parte inferior do formulário para gerar suas credenciais de API.
- Para visualizar suas credenciais de API, clique em Mostrar detalhes.
- Suas credenciais de API - Cliente ID e Segredo do cliente - são mostrados logo abaixo dos URIs de redirecionamento. Abaixo de suas credenciais estão URLs de amostra e chamadas de API com suas credenciais pré-preenchidas.
Use suas credenciais
Agora que você tem suas credenciais, é hora de começar a usar o ORCID API pública!
Observe que podemos transferir suas credenciais para o membro API se você se tornar um ORCID membro. Entre em contato com nossa equipe de engajamento se tiver alguma dúvida.