We've recently updated ORCID'S Privacy Policy to be simple to understand and easy to navigate. We invite you to read it here.

Connecting research and researchers

You are here: Home / Hands on with the ORCID API / 1. Getting started

Step 1

Things to complete before you start

Make sure you have everything ready to go through this tutorial

Things to complete before you start

Before you can make a start with this tutorial you need to have completed the 3 steps below:

  1. Request Sandbox Member API Credentials
  2. Create a Sandbox ORCID account
  3. Configure your google oauth playground

For this tutorial, we’ll use ORCID’s test environment, the ORCID Sandbox. The Sandbox works just like the production ORCID Registry, with a few exceptions:

  • Sandbox only sends emails to mailinator.com addresses
  • The majority of the Import wizard tools don’t work in the Sandbox
  • Menu links to informational content (About, For Researchers, Membership, etc) don’t work in the Sandbox
  • Sandbox doesn’t contain any production data

Request Sandbox Member API Credentials

API credentials consist of a client ID and a client secret which are needed in order to collect authenticated iDs and/or user permissions to interact with their ORCID record.  Please apply for your Sandbox credentials here. Add a note to advise that you are testing with google OAuth Playground. Please be aware that this is a manual process and can take up to 24 hours for the credentials to be created. 

Create a Sandbox ORCID account

In a new window or tab, visit https://sandbox.orcid.org/register

  1. Enter your name and email address, and then click the “next” button. IMPORTANT! Don’t use a real email address! Instead, make up an address ending in @mailinator.com
  2. Complete step 2 of the registration form with a password, and move on to step 3.
  3. Select your preferred visibility setting, accept the terms of use, click the box next to the text “I’m not a robot”, and finally click the “register” button. 

Remember the email and password – you’ll need these throughout the tutorial!

Configure your Google OAuth Playground

  1. Go to Google OAuth Playground 
  2. Click the gear icon in the upper right corner to open the OAuth 2.0 Configuration
Image of the OAuth 2.0 configuration
  1. Change the Oauth endpoints drop-down to Custom and enter the following settings and click Close
Image of OAuth settings that are required

Important! Keep the Google OAuth Playground open so that you don’t lose the configurations you have made in the steps above. You can also save the URL that allows you to initialize the Playground with these configurations (to get the URL, click the link icon next to the gear icon in the upper right corner).

Steps in this tutorial