Frequentemente me perguntam como ORCID consegue atualizar continuamente o Registro para adicionar novos recursos, mas ainda suporta os muitos sistemas de nível empresarial pertencentes e operados por ORCID Organizações membros que usam nossas APIs. A resposta final é flexibilidade. Mas, é claro, é um pouco mais complicado do que isso.
Um pouco de história
Quando lançamos pela primeira vez em outubro de 2012, começamos com a versão 1.0.1 da API. (Nosso protótipo anterior era a versão 1.0.) Como você pode imaginar, durante o primeiro ano, fizemos muitos aprimoramentos e adicionamos novas funcionalidades importantes, como a capacidade de conectar financiamento e afiliações a um ORCID Registro. Para cada uma dessas melhorias, mantivemos a compatibilidade com versões anteriores, permitindo que as organizações se atualizem em seu lazer. Um ano (e 23 atualizações!) Depois, descobrimos que estávamos oferecendo suporte ativo a 23 versões de nossa API. Isso exigia recursos substanciais de pessoal para gerenciar e significava que tínhamos menos tempo para adicionar mais recursos e melhorias que nossos membros e usuários buscavam. Pior ainda, quase todos os usuários da API estavam usando a versão 1.0.7 ou anterior, o que significa que eles não estavam se beneficiando dos novos recursos que estávamos implementando e oferecendo suporte. É claro que esse processo não estava funcionando bem para ninguém!
Focando nossa abordagem
Em novembro de 2013, desenvolvemos uma abordagem com os seguintes objetivos:
- Mantenha o número de APIs com suporte simultâneo em um nível gerenciável para nossa pequena equipe.
- Fornece melhores informações aos usuários da API sobre quais são as atualizações principais e secundárias da API.
- Atende usuários de API que gostariam de ter acesso às atualizações e funcionalidades mais recentes e que exigem APIs de longo prazo e estáveis para empresas.
- Habilite a flexibilidade para usuários de API que estão migrando ativamente para versões mais novas, embora precisem de suporte extra ou tempo para a transição.
A API Enterprise-Stable
Agora, lançamos uma nova versão de API estável para empresas uma vez por ano, geralmente em janeiro. Esta versão inclui todas as novas funcionalidades, atualizações e melhorias do ano anterior.
- Embora a versão empresarial estável anterior ainda esteja funcional, ela é considerada "obsoleta".
- Os usuários da API são informados 3-6 meses antes da data de expiração das diferenças entre as duas versões e recebem documentação e suporte para atualizar seu sistema. Também fornecemos um aviso aos nossos contatos técnicos que criaram uma integração com a API membro.
- Após um período de tempo, a versão antiga é “desativada”, após o qual ela não é mais ativada. Eventualmente, a versão antiga não funcionará mais.
- A quantidade de tempo em que ambas as versões são ativamente suportadas varia dependendo da extensão das mudanças e do esforço necessário para fazer uma atualização.
- Estamos comprometidos com nossos membros. SEMPRE garantimos que eles tenham migrado com sucesso para a nova versão antes de descontinuar o suporte para uma versão de API obsoleta.
A API de inovação
Para nossos membros que desejam acesso antecipado a novos recursos e melhorias, fornecemos APIs de candidatos a lançamento mais frequentes que incluem as inovações mais recentes.
- Essas versões fornecem uma visão antecipada das atualizações prováveis na próxima versão estável para empresas.
- Eles incluem a funcionalidade que estamos testando e permitem que os usuários da API experimentem a nova funcionalidade mais cedo.
- Candidatos à versão geralmente não têm suporte e têm documentação limitada. o ORCID A equipe de desenvolvimento está muito interessada em trabalhar em colaboração com os membros usando candidatos a lançamento para melhorar a funcionalidade provisória.
Fornecemos detalhes sobre as versões atuais, datas em que as mudanças estão acontecendo e muito mais em nosso documentação da versão. Também recomendamos que qualquer pessoa que use a API se torne membro do Grupo de usuários API onde compartilhamos as informações mais recentes sobre as APIs.