API pública

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 se registrar 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
  Nota: 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 antes de se registrar para obter credenciais de API públicas
• Leia e concorde com os 'ORCID Termos de Serviço do Cliente Público
• Clique no botão “Registre-se para ORCID credenciais públicas da API”.

Preenchendo o formulário de detalhes do aplicativo

• Depois de se registrar para obter suas credenciais de API públicas, você será direcionado de volta às Ferramentas do desenvolvedor (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
• Você precisa preencher o formulário de detalhes do aplicativo 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).
  • URL do aplicativo: O site que o usuário pode visitar para saber mais sobre seu aplicativo. Isso também será exibido em seus Lista de organizações confiáveis.
  • Descrição da Aplicaçã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.

Adicionando URIs de redirecionamento

Depois que o usuário autorizar seu aplicativo, ele será retornado a um URI que você especificar. Você deve fornecer esses URIs com antecedência ou seus usuários de integração enfrentarão um erro.

• Insira seu URI de redirecionamento na caixa fornecida
• Se você precisar inserir mais de 1 URI de redirecionamento, clique em 'Adicionar outro URI de redirecionamento'

Observe:

• Somente URIs HTTPS são aceitos na produção
• Domínios registrados DEVO correspondem exatamente aos domínios usados, incluindo subdomínios
• Registre todos os URIs de redirecionamento totalmente, sempre que possível. Esta é a opção mais segura e a que recomendamos. Para obter mais informações sobre URIs de redirecionamento, consulte nosso Perguntas frequentes sobre URI de redirecionamento

Salvando seu aplicativo

Depois de preencher o formulário de inscrição e adicionar seus URIs de redirecionamento, você pode salvar sua inscrição.

• Clique em 'Salvar meu aplicativo e gerar meu cliente ID e segredo'

Você será direcionado de volta para a página de ferramentas do desenvolvedor, que agora incluirá suas credenciais de cliente da API pública

Atualizando suas credenciais

Fazer uma alteração nas informações do seu aplicativo é muito simples.

• Edite as informações relevantes e clique em 'Salvar aplicativo'

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 no futuro.

Navegue nosso Grupo de usuários API tópicos para obter mais informações sobre como configurar uma integração com a API pública. No entanto, para maximizar os benefícios da ORCID, recomendamos você juntar ORCID como membro organizacional, que oferece acesso a funcionalidades adicionais, assistência pessoal de nossa equipe de integração e, claro, ajuda a apoiar nosso trabalho.