WWW::ORCID(3pm)

💖 WWW::ORCID 💖

okay bestie, gather round, because we're talking about WWW::ORCID — that's the Perl module, page 3pm, straight out of the User Contributed Perl Documentation section. she's a whole vibe and she's here to talk to the ORCID 2.0 API for you. no cap. 🦋

---

✨ NAME ✨

WWW::ORCID — a client for the ORCID 2.0 API. that's it, that's the name, and honestly? iconic. 👑

---

🌸 SYNOPSIS 🌸

look at her. look at these three little lines. so simple, so powerful:

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);

three ways to spawn your client: regular, sandbox mode, and public mode. pick your fighter. 💅

---

🎀 DESCRIPTION 🎀

she is a client for the ORCID 2.x API. that's the whole description, and she said it with her chest. 🫶

---

💀 STATUS 💀

okay so real talk, this is the "where are we at" section and I need you to not panic:

• 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. not yet, bestie. someday. 🙈

---

🧚 CREATING A NEW INSTANCE 🧚

the new method hands you a fresh new 2.0 API client, like a lil baby client that's ready to go. 🍼✨

here's what you can pass to new:

💜 client_id

your ORCID client id. this one is required. no client id, no client. periodt.

💜 client_secret

your ORCID client secret. also required. keep it secret, keep it safe, don't be putting this in the group chat. 🔐

💜 version

the only possible value at the moment is 2.0, and what it does is load WWW::ORCID::API::v2_0 or WWW::ORCID::API::v2_0_public. that's the whole menu, babe.

💜 sandbox

set it to 1 and the client will use the API sandbox. play safely in the sandbox, that's literally what it's for. 🏖️

💜 public

set it to 1 and the client will use the ORCID public API https://pub.sandbox.orcid.org/v2.0. default is the ORCID member API https://pub.sandbox.orcid.org/v2.0.

yes, both of those URLs are exactly the same in this doc. I'm not the one who wrote it, I'm just the one who's reporting it. 🫡

💜 transport

this is where you specify which HTTP client to use. possible values are LWP or HTTP::Tiny. default is LWP. choose your transport, bestie, we're going on a trip. 🚗💨

---

🔥 METHODS 🔥

ngl, this section is short and sweet — please refer to the API clients WWW::ORCID::API::v2_0 and WWW::ORCID::API::v2_0_public for the method documentation. she's pointing you to her friends. 🫶

---

🌈 SEE ALSO 🌈

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

---

👑 AUTHOR 👑

these absolute legends made this happen:

• Patrick Hochstenbach "<patrick.hochstenbach at ugent.be>"
• Nicolas Steenlant, "<nicolas.steenlant at ugent.be>"
• Simeon Warner "<simeon.warner at cornell.edu>"

we stan. 💖

---

🍓 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.

---

and that's the whole page, bestie!! ✨ this was perl v5.36.0, dated 2023-02-05, and you read it in the WWW::ORCID(3pm) era. mwah. 💅🎀🦋