Passo 2 (de 5)
2. Recolher Autenticado ORCID IDs e permissões
Nesta etapa, aprenda como obter um Authenticated iD e a permissão necessária para ler e gravar dados de e para um ORCID registro.
ORCID integrações usam “OAuth de 3 pernas” para autenticar usuários e solicitar permissão para interagir com seus registros. ORCID os membros podem usar a API Member para solicitar permissões de leitura e gravação.
Nesta seção, percorreremos as etapas que sua própria integração personalizada precisaria concluir para obter um Authenticated iD e permissão para ler e escrever em um ORCID registro
Obtendo um Autenticado iD e registrar a permissão de acesso de um usuário envolve seguir OAuth2.0, um protocolo padrão da indústria para autorização. OAuth permite que um usuário dê a um site ou aplicativo acesso a informações de conta armazenadas em outro site, sem fornecer a senha a esse site.
Se você já fez login em um site usando o Google ou o Facebook em vez de suas credenciais para esse site específico, você já usou o OAuth!
O processo OAuth inclui 3 etapas:
- Criar um URL de autorização
- Obter um código de autorização
- Troque o código de autorização por um token de acesso
Para iniciar o processo OAuth, precisaremos criar um URL de autorização especial que envie os usuários para um ORCID tela de login. Este URL consiste em Ponto de extremidade de autorização, mais parâmetros que identificam sua organização e as permissões que você deseja solicitar.
Parâmetro | Descrição | Exemplo |
---|---|---|
tipo_de_resposta | código | |
escopo | Ações de API para as quais você deseja solicitar permissão, na lista de ORCID Escopos | /pessoa/atualização /atividades/atualização / read-limited /autenticar |
client_id | Seu cliente membro ID (emitida pela ORCID) | [APLICATIVO- ***] |
url de redirecionamento | Página que os usuários verão depois de concluírem o processo de autorização. (Para este tutorial, será Google OAUth Playground) | https://developers.go ogle.com/oauthplayground |
Para solicitar permissão para adicionar/atualizar atividades (afiliações, financiamento, trabalhos, revisão por pares, recursos de pesquisa) e para adicionar/atualizar itens pessoais (outros nomes, palavras-chave, países, URLs de pesquisadores, sites e identificadores externos pessoais) e para ler o ORCID registro, a URL de autorização será:
https://sandbox.orcid.org/oauth/authorize?client_id=[APP-****************]&response_type=code&scope=/read-limited%20/activities/update%20/person/update&redirect_uri=https://developers.google.com/oauthplayground
Mas podemos usar o playground do Google OAuth para nos ajudar a criar o URL de autorização
- Adicione /activities/update, /person/update, /read-limited no campo scopes e clique em Authorize API's.
A URL de autorização teria sido criada usando as informações que você inseriu nos campos de configuração e escopo.
- An ORCID aparecerá a tela de login; entre na sua conta Sandbox com o endereço de e-mail e a senha que você usou para criar seu ORCID conta no início deste tutorial. Depois de fazer login, a tela OAuth será exibida. O nome do cliente e os escopos relevantes serão exibidos nesta tela. Para conceder acesso, você precisa clicar em 'Autorizar acesso'
- Depois de conceder a permissão, você será redirecionado de volta ao Google OAuth Playground, pois esse era o URI de redirecionamento associado à sua credencial do Sandbox. Um código de autorização de 6 caracteres aparecerá no final do URI de redirecionamento na barra de endereço do navegador (e sob o Passo 2 seção à esquerda da página no google oauth playground)
Secure https://developers.google.com/oauthplayground/code=s536Z5
Depois de ter um código de autorização, você pode trocá-lo por um token de acesso e o Authenticated iD do usuário que fez login, que você precisará para realizar as ações de API para as quais solicitou permissão.
Em uma situação do mundo real, essa troca seria feita pelo seu sistema, usando uma linguagem de programação como PHP, Java ou Ruby on Rails. Para este tutorial, usaremos o Google OAuth Playground para simular um aplicativo da web.
- Clique 'Trocar código de autorização para tokens'
Depois de clicar em “Código de autorização de troca para tokens” Seu token de acesso e autenticado iD aparecerá no Pedido / Resposta seção à direita. Por favor, veja o exemplo abaixo:
{
"name": "Sophia Garcia"
"access_token": "53737721-9cdb-442a-8b77-409609bb5e43",
"expires_in": 631138518,
"token type": "bearer",
"orcid":
"0000-0002-4456-8947"
"scope": "read-limited /activities/update person/update "
"refresh token": "cOfc38fd-291e-4633-a365-6f4afa304344"
}
- Salve este token!
É importante salvar o token que você recebeu na etapa acima, pois você pode criar facilmente as chamadas que precisar fazer com ele. Recomendamos que você armazene a resposta completa da troca de token
Você agora coletou um Autenticado ID e permissão do usuário para ler seus ORCID gravar e atualizar seus ORCID registro.