Debian Codegraph @

README

raw
1 NAME
2
3 WWW::ORCID - A client for the ORCID 2.0 API
4
5 SYNOPSIS
6
7 my $client = WWW::ORCID->new(client_id => "XXX", client_secret => "XXX");
8
9 my $client = WWW::ORCID->new(client_id => "XXX", client_secret => "XXX", sandbox => 1);
10
11 my $client = WWW::ORCID->new(client_id => "XXX", client_secret => "XXX", public => 1);
12
13 DESCRIPTION
14
15 A client for the ORCID 2.x API.
16
17 STATUS
18
19 The client is mostly complete. The 2.0 member API is implemented except
20 notification-permission. The 2.0 public API is implemented except
21 identifiers and status. The 2.1 member API has not yet been
22 implemented.
23
24 CREATING A NEW INSTANCE
25
26 The new method returns a new 2.0 API client.
27
28 Arguments to new:
29
30 client_id
31
32 Your ORCID client id (required).
33
34 client_secret
35
36 Your ORCID client secret (required).
37
38 version
39
40 The only possible value at the moment is "2.0" which will load
41 WWW::ORCID::API::v2_0 or WWW::ORCID::API::v2_0_public.
42
43 sandbox
44
45 The client will use the API sandbox if set to 1.
46
47 public
48
49 The client will use the ORCID public API
50 <https://pub.sandbox.orcid.org/v2.0> if set to 1. Default is the ORCID
51 member API.
52
53 transport
54
55 Specify the HTTP client to use. Possible values are LWP or HTTP::Tiny.
56 Default is LWP.
57
58 METHODS
59
60 Please refer to the API clients WWW::ORCID::API::v2_0 and
61 WWW::ORCID::API::v2_0_public for method documentation.
62
63 SEE ALSO
64
65 https://api.orcid.org/v2.0/#/Member_API_v2.0
66
67 AUTHOR
68
69 Patrick Hochstenbach <patrick.hochstenbach at ugent.be>
70
71 Nicolas Steenlant, <nicolas.steenlant at ugent.be>
72
73 Simeon Warner <simeon.warner at cornell.edu>
74
75 LICENSE AND COPYRIGHT
76
77 This program is free software; you can redistribute it and/or modify it
78 under the terms of either: the GNU General Public License as published
79 by the Free Software Foundation; or the Artistic License.
80
81 See http://dev.perl.org/licenses/ for more information.
82