This guide goes over the steps to register for client credentials to use the public API. ORCID members need not register for the public API as their member credentials can be used instead. To register for member credentials see Register a client application.
We recommend that developers test their use of the public API in the developers sandbox before using the production version. Once tested in the sandbox environment, your application will be ready for production credentials.
For more general information see the Public Client ORCID API.
Enable developer tools on your account
Sign into your ORCID record and go to the Developer Tools tab at the top of your record. Note that you must verify your email address before you can access the Developer Tools.
Once developer tools are enabled, you will see the form to complete the credential information.
The public client is available on personal ORCID records and cannot be transferred to another person. For credentials to use as an organization -- and to update ORCID records -- you will need to become an ORCID member.
Register a public client
On the developer page fill in a name, description, and website for the application that you are developing; these values will be displayed to users. Also list any redirect URIs for your clients. For more information about how redirect URIs work with the ORCID API see about redirect URIs. Public clients must have at least one redirect URI registered, and the URI must begin with an http or https prefix.
To make testing easier, you can automatically add a link to the Google OAuth Playground by clicking that option under Test redirect URIs. Instructions for using the Playground will be displayed. Click save when you are done.
View your credentials
After you have registered for credentials you'll see the credentials listed in the Developer Console display, click Show Details to see the full credentials. This will display your client iD and secret that you will use when making calls to the API. It also includes example Authorize and Token URLs complete with your credential information.
Note that all ORCID client credentials issued after December 1, 2014 begin with the characters "APP" and are alpha numeric. Earlier version of client credentials had the same format as ORCID iDs (sixteen digits). Both formats of client credentials behave the same way, though our documentation primarily uses the old format in examples.
Use your credentials
You can now use your credentials to make calls on the public API. Learn how:
- Tutorial: Retrieve a validated ORCID iD
- Tutorial: Retrieve data using the public API
- Tutorial: Search data using the ORCID APIs