Technical Working Group
API Working Group
The 2015 technical development plan includes several updates to the ORCID API. The key objective in these updates is to enable greater scalability, particularly in how API users interact with the items attached to an ORCID Record, such as works, funding and affiliations.
During the updates to the API for scalability, there also will be opportunities to make changes that will make the API easier to use, make terms more consistent with those used in ORCID communications and membership materials, or make the API more consistent with general API best practices.
There are often multiple approaches that can be taken to achieve these objectives, each with their own sets of benefits and consequences. We are establishing an API working group to provide input on the changes made, and the ways in which these changes may affect current and prospective API users. The working group also will comment on communication plans with API users, and the migration plan for rolling out changes, and would help communicate these decisions to the greater ORCID API community.
API Working Group will provide technical and policy guidance on design and implementation of the APIs:
- Small group of 5-7 individuals, including those who already use the ORCID APIs, and/or have experience in designing and maintaining nimble OAuth, RESTful APIs
- Approximate engagement timeframe: March 2015 through December 2015. Meetings likely every three weeks.
- Outcomes/deliverables: feedback and suggestions on API changes, and communication/ migration plans; guest blog posts and/or quotes for communications published about the API changes; statement on ORCID API changes
Why convene this group?
To better understand the breadth of possible changes to the API, we have listed possible projects below. Note that some of these projects may not be completed during 2015, or at all.
- Per-work API (change to existing API) - allow works, funding, affiliations and other things in lists to be updated individually rather than as a list. Included because lists of works were growing increasingly difficult to manage, particularly for researchers that have long lists of items on their record.
- Notifications API (new API) - enable someone to post a specific notification to a researcher’s “inbox” on the ORCID website. In this first iteration notifications are limited those indicating that the API user has items that could be added to the user’s ORCID Record. Note that this functionality would be limited to a subset of API users, and would be governed by policies on sending messages to users.
- API Scope simplification (change to existing API) - reduce the number of API scopes used when asking users for permission to access their records. Included because currently there are 15 different scopes (access permissions) that API users use to interact with the API. This work would reduce the number of scopes to closer to 6.
- API error handling (change to existing API) - update to how error messages are expressed so that they are more verbose and provide better guidance to the API user.
- Public API - Search (change to existing API) - move API searching and possibly other unregistered public API use under the registered, public client, enabling ORCID to better monitor resource use and control potential overuse if it occurs.
- Biographical Information API (change to existing API) - improve update protocols, provenance handling and history tracking for API changes. This change may affect internal processing more than API user interaction.
- RDF Support (extension of API) - add support for RDF content types including FOAF, CERIF, and possibly Dublin Core for content negotiation.
Working Group Members
We are excited to work with a fantastic group of API advocates and experts: