Nesta entrevista Rob Peters, ORCIDdo Diretor de Tecnologia, apresenta ORCIDnova API da - lançada em 14 de fevereiro de 2017
Antes de começarmos a falar sobre a nova API, você pode nos contar um pouco sobre ORCIDEquipe Técnica de e sua função como Diretor?
À primeira vista, o ORCID equipe se parece muito com qualquer outra equipe técnica. Temos cinco desenvolvedores, um administrador de servidor, um analista de garantia de qualidade e, claro, um gerente (eu). No entanto, o que fica interessante são nossas diferentes origens geográficas, culturais e de trabalho. Três de nós estão sediados nos Estados Unidos, três na Costa Rica e dois no Reino Unido, portanto, geograficamente, temos muitas perspectivas. Além disso, alguns de nós são da consultoria de software tradicional, outros vêm da indústria editorial, startups do “Vale do Silício” e bibliotecas científicas.
Minha função pessoal como Diretor de Tecnologia é gerenciar o desenvolvimento de software do dia-a-dia. Isso se resume a ajudar minha equipe a se comunicar entre si e com o resto da organização, bem como gerenciar quais tarefas a equipe assume (e quais são adiadas). Eu também tenho a oportunidade de ter muitas informações sobre decisões estratégicas de alto nível ORCID faz.
Passando para a versão 2.0 da API - por que nós - ORCID, Bem como o ORCID comunidade - precisa desta atualização?
O primeiro ORCID O API, lançado em outubro de 2012, baseou-se inevitavelmente em muitas suposições que mais tarde se mostraram erradas e / ou exigiram refinamento. Para melhor servir a comunidade de pesquisa, temos que examinar continuamente essas suposições. Usar feedback, fazer perguntas e observar evidências que não estavam disponíveis antes do lançamento nos deu novos insights sobre o que ORCID API deve e não deve ser. Como você verá na minha resposta à próxima pergunta, a versão 2.0 representa uma grande ruptura com as suposições de que a 1.0 foi construída, embora ainda seja pragmática o suficiente para fornecer continuidade entre as duas APIs.
Quais são as principais diferenças entre 1.2 e 2.0 e como eles irão beneficiar os membros?
No desenvolvimento do 2.0, queríamos resolver os obstáculos que os membros têm enfrentado com o 1.2 e também introduzir novas funcionalidades que sabemos que a comunidade deseja.
Assim, além de resolver problemas conhecidos, como escalabilidade no gerenciamento de publicações de hiper-autoria e desafios com comportamento implícito que estavam causando confusão para os membros, também adicionamos uma nova funcionalidade para oferecer suporte ao reconhecimento de revisão por pares, notificações aprimoradas para usuários e a capacidade de apoiar quase qualquer identificador persistente.
Para explicar por que algumas dessas mudanças foram necessárias, vou ser um pouco mais técnico. Antes de começarmos a codificar uma única linha nova, fizemos uma lista de coisas que queríamos ver melhoradas, com o seguinte “manifesto”:
- Pare de pensar no ORCID registro como um documento monolítico (grande e único). Várias instituições escrevendo para um ORCID registro significa reconhecer que o registro é Multi inquilino. Além disso, os pesquisadores muitas vezes produzem uma quantidade tão grande de pesquisas que nem mesmo seus resumos cabem em um documento monolítico.
- Escopos simplificados. A granularidade dos escopos de permissões na API 1.0 é esmagadora para todas as partes envolvidas; simplificá-los tornará a vida mais fácil para desenvolvedores e usuários.
- Explícito Repousante comportamento. Os comportamentos implícitos são ruins para os implementadores, pois levam a um comportamento inesperado que, por sua vez, confunde os usuários finais. Usando o comportamento RESTful, nossa nova API evita esses problemas.
- URLs mais curtos razoáveis. Um bom exemplo seria / works / 1234 é melhor que /orcid-works / 1234.
- As chamadas para a lista retornam apenas resumos. Para tornar a chamada de um registro mais rápida, a API 2.0 retorna apenas resumos de listas. Fazer uma chamada para cada informação sobre um pesquisador não funciona para artigos de hiper-autoria, onde existem dezenas, centenas ou mesmo milhares de autores.
- Nomes e estruturas comuns para elementos comuns. 2.0 nos permite garantir que os elementos comuns no XML / JSON tenham os mesmos nomes.
- códigos de erro. Agora incluímos códigos de erro no corpo da resposta quando o erro não é totalmente descrito por um código HTTP padrão.
E quais são os benefícios para os usuários?
No final do dia, uma API deve ser perfeita para os usuários. O comportamento inesperado do 1.0 surge e afeta a experiência do usuário, ao mesmo tempo que frustra os desenvolvedores que estão implementando a API. Em um nível prático, a nova API permite otimizar cada seção no ORCID registro para fornecer de forma consistente a aplicação de configurações de visibilidade, fonte e data de criação para itens em cada seção.
Isso afetará a API pública também? Como?
sim. As alterações na API de membros e na API pública são sempre travadas. Embora apreciemos e contemos com o apoio dos membros, também estamos comprometidos com nossa visão mais ampla "de um mundo onde todos os que participam da pesquisa, bolsa de estudos e inovação são exclusivamente identificados e conectados às suas contribuições através de disciplinas, fronteiras e tempo" Vemos a API pública como um meio de ajudar a atingir esse objetivo.
Quais você acha que serão os principais desafios no lançamento da nova versão e qual suporte ORCID estar fornecendo?
A questão mais difícil é reservar recursos para fazer o trabalho de atualização. Para algumas organizações, pode demorar apenas alguns dias e outras podem exigir um mês inteiro. Independentemente do prazo, não tenha medo de pedir ajuda, mesmo que seja um pequeno detalhe que esteja impedindo seu progresso. Documentação completa já está disponível para membros.orcid.org e ORCID organizações membros também podem Contacte-nos. Postando para o Fórum de usuários API pode ser útil, trazendo comentários de toda a ORCID comunidade. Também acredito piamente em estar diretamente disponível, então sinta-se me mande um email diretamente.
Quem está usando a API 2.0 atualmente e que tipo de feedback eles forneceram?
Nós nos esforçamos muito para disponibilizar os candidatos a lançamento para obter feedback. CrossRef, Datacite, CERN e PTCRIS são apenas alguns dos ORCID membros que implementaram um candidato a lançamento e forneceram feedback. Além disso, várias organizações implementaram a funcionalidade de revisão por pares usando 2.0, incluindo os primeiros a adotar, a American Geophysical Union, F1000 e Publons. O feedback incluiu as sugestões “técnicas” usuais, como nomes usados no esquema, nomenclatura de endpoint ou debates sobre eficiência. Esses tipos de detalhes podem ter grandes implicações para os membros. No entanto, os implementadores de candidatos a lançamento também fornecem feedback da perspectiva do pesquisador, que consideramos inestimável.
Quanto tempo ORCID continuar a oferecer suporte à API antiga?
Pretendemos expirar 1.2 no final de 2017. Independentemente da data de expiração, se você concordar com ORCIDmissão de e se preocupam com a interação dos pesquisadores com ORCID você vai querer mudar para 2.0 agora.
Mais alguma coisa que devemos saber sobre essa mudança?
Esperamos que 2.0 se mostre durável e possamos nos concentrar em outras partes do ORCID pilha de tecnologia por um bom tempo!
Para obter um resumo divertido e prático dos recursos da API 2.0, consulte este conjunto de slides!