www-orcid's Introduction

NAME

WWW::ORCID - A client for the ORCID 2.0 API

SYNOPSIS

my $client = WWW::ORCID->new(client_id => "XXX", client_secret => "XXX");

my $client = WWW::ORCID->new(client_id => "XXX", client_secret => "XXX", sandbox => 1);

my $client = WWW::ORCID->new(client_id => "XXX", client_secret => "XXX", public => 1);

DESCRIPTION

A client for the ORCID 2.x API.

STATUS

The client is mostly complete. The 2.0 member API is implemented except notification-permission. The 2.0 public API is implemented except identifiers and status. The 2.1 member API has not yet been implemented.

CREATING A NEW INSTANCE

The new method returns a new 2.0 API client.

Arguments to new:

`client_id`

Your ORCID client id (required).

`client_secret`

Your ORCID client secret (required).

`version`

The only possible value at the moment is "2.0" which will load WWW::ORCID::API::v2_0 or WWW::ORCID::API::v2_0_public.

`sandbox`

The client will use the API sandbox if set to 1.

`public`

The client will use the ORCID public API if set to 1. Default is the ORCID member API.

`transport`

Specify the HTTP client to use. Possible values are LWP or HTTP::Tiny. Default is LWP.

METHODS

Please refer to the API clients WWW::ORCID::API::v2_0 and WWW::ORCID::API::v2_0_public for method documentation.

AUTHOR

Patrick Hochstenbach <patrick.hochstenbach at ugent.be>

Nicolas Steenlant, <nicolas.steenlant at ugent.be>

Simeon Warner <simeon.warner at cornell.edu>

LICENSE AND COPYRIGHT

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

www-orcid's People

Contributors

Watchers

www-orcid's Issues

Support for API v2.0

On February 14th, ORCID released a new version of their API.

According to them:

We are aiming to sunset 1.2 in late 2017. Regardless of the sunset date, if you agree with ORCID’s mission and care about researchers interact with ORCID you’ll want to move to 2.0 now.

What is the plan for changes in this distribution to support 2.0? Since the old API will sunset as early as late this year, I imagine having a new namespace (such as WWW::ORCID::v2 or something like that) is not so useful.

I haven't looked at this in detail, but I'm thinking it could be specified in the constructor. As in

# From now and for some time
# Maybe issuing a warning?
my $old = WWW::ORCID->new;
my $new = WWW::ORCID->new(
  version => 2.0,
);

# From that cutoff time until "late 2017"
my $old = WWW::ORCID->new(
  version => 1.0,
);
my $new = WWW::ORCID->new;

That way, we ensure not to break compatibility too suddenly, and we maintain the current namespace.

If this looks reasonable, I can submit a PR.

nics / www-orcid Goto Github PK

www-orcid's Introduction

NAME

SYNOPSIS

DESCRIPTION

STATUS

CREATING A NEW INSTANCE

client_id

client_secret

version

sandbox

public

transport