Os sistemas do fornecedor podem oferecer aos clientes já prontos ORCID integrações, proporcionando-lhes todos os benefícios de seus ORCID adesão sem ter que construir sua própria integração. Este fluxo de trabalho descreve as diretrizes gerais para a construção de um ORCID integração como um fornecedor que oferece software aos clientes. Ao construir o seu ORCID integração de que você precisará para garantir que sua integração permita que seus clientes atendam a requisitos para emissão de credenciais de API de membro , bem como seguir nossas melhores práticas de integração.
- Autenticar ORCID IDs usando o processo OAuth para indivíduos para garantir que eles estejam corretamente associados a suas afiliações e contribuições.
- Ecrã os IDs autenticados publicamente em seu sistema de acordo com nossas diretrizes de exibição, para sinalizar aos pesquisadores que seu sistema está preparado para oferecer suporte ao uso de ORCID.
- Conecte-se: dados dos usuários de seu sistema para seus ORCID registros, permitindo que seus clientes atualizem seus registros de pesquisadores quando necessário.
- Recolha dados dos usuários de seus ORCID registro para ajudar a preencher dados em seu sistema ou formulários.
- Sincronizar os dados do seu sistema com o ORCID Registro por meio de um fluxo de informações bidirecional.
Recomendamos que você entre em contato com seu líder de engajamento para discutir seus planos de integração antes de iniciar seu desenvolvimento.
CONFIGURAÇÃO DO SISTEMA
Todos os sistemas que se conectam com ORCID precisa armazenar o ORCID IDs e tokens de acesso coletados, e você também pode armazenar informações lidas a partir do ORCID registro.
- Armazene IDs autenticados: Seu sistema deve ser capaz de aceitar e armazenar ORCID IDs juntamente com as informações do usuário.
- Código de autorização de troca: Seu sistema deve ser capaz de capturar um código de autorização de seis dígitos e trocá-lo por um token de acesso imediatamente.
- Armazene a resposta do token: Seu sistema também deve ser capaz de aceitar e armazenar ORCID iD e o token de acesso. Recomendamos que você armazene a resposta completa do token junto com as informações do usuário, incluindo:
- Tokens de acesso persistente
- Atualizar tokens
- Escopos solicitados
- Expiração do escopo
- Itens para armazenar ao gravar dados: Se o seu sistema grava dados para ORCID registros:
- Seu sistema deve ser capaz de salvar um colocar código para cada item adicionado a um ORCID registro (e grupo ID para revisão por pares). Os códigos de colocação são identificadores únicos para itens dentro do ORCID Registry.
- Seu sistema deve ser capaz de enviar dados em XML ou JSON formatados no ORCID esquema de mensagem.
- Log de interações: Seu sistema deve registrar ambas as chamadas feitas para o ORCID API e respostas recebidas; isso é necessário para que nossa equipe possa ajudar se um problema ocorrer mais tarde. Idealmente, seu cliente também deve ser capaz de ler e compartilhar esses logs.
- Seleção de API: Seu sistema deve permitir que os clientes selecionem se estão usando credenciais de API públicas ou de membro (se o seu sistema permitir ambas).
- Exportação de dados: Seu sistema deve oferecer uma maneira para seus clientes exportarem os arquivos armazenados ORCID iDs e dados de troca de tokens (tokens de acesso, tokens de atualização, escopos, expiração de escopo). Se o seu sistema também grava dados, ele também deve incluir os códigos de entrada relevantes com as exportações de dados.
ORCID CREDENCIAIS DE API
ORCID requer que a organização que solicita os dados, ou seja, seu cliente, use seus próprios ORCID Credenciais de API. Isso indica claramente quem está solicitando acesso para atualizar ORCID registros e é exigido por ORCIDacordo de associação de. A organização deve obter o ORCID Credenciais de API por conta própria. Se você estiver ajudando a organização no gerenciamento do sistema e suas credenciais de API exigirem mudanças, como atualizar os URIs de redirecionamento, a organização deve enviar a solicitação de mudanças.
CONHEÇA O SEU SISTEMA
Quando estiver pronto para lançar seu sistema, contacte-nos para iniciar o processo. Precisamos saber:
- O nome do seu sistema e o nome do desenvolvedor.
- Uma breve descrição de sua funcionalidade e como ela se conecta ao ORCID Registry.
- Sua disponibilidade para uma revisão de integração, para que possamos determinar se ORCID os membros devem passar por uma análise de integração completa antes de receber as credenciais da API, bem como confirmar como o seu sistema ajuda os membros a atender o Collect & Connect.
- Links para páginas, apresentações e / ou sistemas de demonstração aos quais podemos indicar organizações para que possam aprender mais sobre o seu sistema.
- Contatos técnicos e administrativos que podemos convidar para ingressar na lista de usuários da API, bem como estabelecer contato direto, para que você possa fornecer a seus clientes as funcionalidades mais recentes.