Primeiros passos com sua integração

Você pode solicitar credenciais de API de membro da sandbox para construir e testar seu aplicativo. Essas credenciais permitem que você faça chamadas para a API de membro premium do sandbox para ler, gravar e atualizar ORCID registros. O acesso ao ambiente de teste sandbox está disponível gratuitamente para qualquer pessoa, mesmo se você não for um ORCID organização membro.

Note: Se você estiver usando um ORCID sistema de provedor de serviços certificado que já suporta ORCID, você não precisa se registrar para obter credenciais da API sandbox, a menos que queira experimentar o ORCID funcionalidade de integração dentro do ambiente Sandbox. 

O sandbox permite que você crie contas de usuário de teste e desenvolva sua integração sem ter que se preocupar em afetar os dados ao vivo (produção) ORCID Registro. A sandbox se comporta da mesma maneira que a produção ORCID Registro com algumas exceções.

Criação de uma conta de teste

A fim de testar o ORCID API e chamadas de API, como leitura e adição de informações a um ORCID registro, você também precisará criar um teste ORCID gravar na caixa de areia. Isso pode ser feito por meio da interface do usuário, bem como na produção ORCID Registro. Vamos para https://sandbox.orcid.org/register e registre-se para uma conta.

Endereços de e-mail do Mailinator

O servidor sandbox só envia e-mails para Mailinator (@mailinator.com) endereços de e-mail para não enviar spam aos servidores de e-mail involuntariamente. Você não receberá um e-mail de verificação ou notificação de redefinição de senha, a menos que use um endereço @mailinator.com, e a verificação é necessária para fazer edições manuais nos registros do sandbox. Saiba mais sobre suas caixas de entrada públicas gratuitas Aqui. Se você não deseja usar um Mailinator endereço, anote seu nome de usuário e senha (pois você os usará para conceder autorização ao seu aplicativo durante o teste) e entre em contato conosco para solicitar assistência com a verificação.

Mailinator é um serviço de e-mail que possui um serviço público gratuito e um serviço privado pago. Para testar, você pode usar o serviço público totalmente gratuito. Saiba mais sobre seus níveis aqui.

Mailinator é um serviço de terceiros que não é gerenciado ou mantido por ORCID. Recomendamos que você analise como esse serviço funciona e suas limitações antes de usar esses endereços.

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 entender melhor.

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.

As integrações precisam armazenar mais do que apenas ORCID registros. Seu sistema deverá ser capaz de:

• Aceitar e armazenar ORCID IDs: Seu sistema precisará saber o iD que acontecerá no marco da ORCID gravar para exibir o iD e atualizar corretamente. Armazene-o junto com as informações do pesquisador que são retornadas na resposta da troca de tokens. Nossa recomendação é armazenar o URI https completo: https://orcid.org/0000-0001-5727-2427.
• Aceitar e armazenar persistente tokens de acesso e tokens de atualização: Os tokens de acesso podem ser usados ​​para ler e atualizar registros, bem como indicar que o iD foi autenticado. Os tokens de acesso são válidos por aproximadamente 20 anos ou até que o usuário os revogue. Também recomendamos que você armazene o escopo de token, expiração de token e tokens de atualização. Os tokens de atualização podem ser usados ​​para criar novos tokens de acesso com escopos iguais ou limitados, se necessário. Armazene os dados do token de acesso junto com as informações do pesquisador.
• Aceitar e armazenar colocar códigos : Cada item que você adiciona ao ORCID O registro será retornado com um código colocado pelo ORCID API. Salve este código put de 6 dígitos junto com o item em seu sistema, é assim que você identificará qual item precisa ser lido, atualizado ou excluído.
• Fornece mensagens de erro e um contato de suporte quando uma interação não ocorre conforme o esperado.

Solicitação de organizações membros ORCID Credenciais de API de membro no servidor de produção (ao vivo) ao preencher o Formulário de inscrição do cliente da API do membro de produção. Antes de emitir credenciais de API de membro de produção, o ORCID A equipe de engajamento/líder do consórcio analisará uma demonstração de sua integração no ORCID caixa de areia. Isso nos dá a oportunidade de ver as ótimas integrações que você construiu e oferecer melhorias no fluxo de trabalho, bem como verificar se todas as integrações atendem às nossas melhores práticas e requisitos mínimos para lançamento.

Para fornecer uma demonstração de seu sistema, você precisará configurar uma integração funcional com o ORCID caixa de areia que o ORCID equipe pode visualizar. Existem algumas maneiras de compartilhar sua integração de sandbox de trabalho:

1. Recomendado: Demonstração ao vivo: Entre em contato para agendar uma demonstração ao vivo. Forneceremos software de reunião que permite compartilhar sua tela para demonstrar sua integração. 
2. Site de teste: Se o seu site de desenvolvimento for público, envie-nos o URL junto com credenciais de teste (se necessário) para acessar seu sistema e instruções que descrevem como usar o seu sistema ORCID recursos. Forneça documentação adicional para verificar o que não poderíamos ver do usuário final, por exemplo, a versão da API usada, quais dados são armazenados pelo seu sistema, etc.
3. Screencast ou capturas de tela:Envie uma gravação ou um conjunto de capturas de tela com descrições explicando e demonstrando claramente como sua integração funciona em cada etapa, incluindo o que acontece se um usuário negar acesso ou desconectar seu ID. Certifique-se de fornecer documentação adicional para verificar qualquer coisa que não conseguiríamos ver do usuário final, como a versão da API usada e como os dados são armazenados

Solicitação de organizações membros ORCID Credenciais de API de membro no servidor de produção (ao vivo) ao preencher o Formulário de inscrição do cliente da API do membro de produção. Se você estiver usando um sistema de fornecedor que não está na lista de ORCID Provedores de serviços certificados, sua integração precisará passar por um processo de revisão para garantir que a requisitos mínimos para integração e melhores práticas são atendidas. 

Você pode entrar em contato com seu Provedor de Serviços não certificado e obter evidências diretamente dele de que os critérios mínimos foram atendidos. Você precisará enviar essas evidências para o ORCID Equipe de engajamento ou seu líder de consórcio.

Existem algumas maneiras de compartilhar essas evidências:

1. Screencast ou capturas de tela: Envie uma gravação ou um conjunto de capturas de tela com descrições explicando e demonstrando claramente como sua integração funciona em cada etapa, incluindo o que acontece se um usuário negar acesso ou desconectar seu iD. Certifique-se de fornecer documentação adicional para verificar qualquer coisa que não poderíamos ver do lado do usuário, como a versão da API usada e como os dados são armazenados.
2. Documentação de integração disponível publicamente: Envie um link acessível publicamente e atualizado que inclua uma descrição clara de como a integração funciona em cada etapa. Como na opção 1, certifique-se de fornecer documentação adicional para verificar qualquer coisa que não poderíamos ver do lado do usuário, como a versão da API usada e como os dados são armazenados.

Você precisará preencher o formulário para registrar um aplicativo cliente. Abaixo está uma visão geral rápida dos campos solicitados:

Nome da Organização: Seu ORCID nome da organização membro

Endereço de e-mail de contato principal para credenciais: Usaremos este endereço de e-mail para enviar a você as credenciais em um e-mail criptografado e para entrar em contato com você caso surja alguma dúvida ou erro em sua integração.

E-mail secundário para senha: um endereço de e-mail para o qual podemos enviar sua senha de e-mail criptografada.

Nome do seu cliente: Este será o seu ORCID nome da organização membro. Se você tiver mais de uma integração, anexaremos o aplicativo ao nome.

URL da página inicial do seu aplicativo: Exibido como um link na lista de organizações confiáveis ​​entre os usuários ORCID página de partes confiáveis. Este deve ser um link para sua organização ou para a página principal do seu aplicativo.

Breve descrição de seu aplicativo cliente: Este texto será exibido na tela de autorização com o ícone de ponto de interrogação para seus usuários de integração. É necessária uma breve descrição da sua integração

Redirecionar URIs: 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. 

• Somente URIs HTTPS são aceitos.
• Os domínios registrados devem corresponder exatamente aos domínios utilizados, incluindo subdomínios.   
• Registre todos os URIs de redirecionamento totalmente, sempre que possível. 
• São necessários mais de 5 URIs de redirecionamento? Indique isso nas Notas para ORCID equipe.

Notas para ORCID para: Use este campo para permitir ORCID a equipe sabe mais alguma coisa sobre sua solicitação ou sua integração

Para apoiar o componente social, oferecemos um kit de ferramentas de Recursos de divulgação para ajudá-lo a desenvolver uma campanha para apoiar sua integração e se comunicar com seus pesquisadores:

• O Quê ORCID é.
• Por que seu sistema coleta IDs e como seu sistema executará tarefas, como atualizar seus registros.
• Por que seus pesquisadores se beneficiarão com a criação de um ORCID iD e conectando seus iDs ao seu sistema.
• Como funciona o dobrador de carta de canal ORCID beneficia a comunidade de pesquisa global mais ampla.

Estaremos construindo continuamente essa “biblioteca” de recursos com base no feedback da comunidade. Se você tiver uma ideia sobre algo que gostaria de ver, não hesite em nos contatar.