summaryrefslogtreecommitdiff
path: root/README
blob: 95b5536159843c5c3b10996b9c6b150c6447c935 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
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
    <https://pub.sandbox.orcid.org/v2.0> 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.

SEE ALSO

    https://api.orcid.org/v2.0/#/Member_API_v2.0

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.