how to use ORCID Swagger interface

184 views
Skip to first unread message

Sheila Rabun

unread,
Jul 16, 2020, 8:11:14 PM7/16/20
to ORCID API Users
Greetings,

I am trying to use the ORCID Swagger interface at https://api.orcid.org/v3.0/ - I am not a developer and I haven't been able to find any documentation on how to use the tool, so I'm just poking around. But, for example, I keep getting a 403 error when trying to retrieve public works from my own ORCID iD. I'm not sure what I'm doing wrong? Swagger seems like it should be straightforward and could be a valuable tool, but I haven't been able to find any information or clarity on how to actually use it properly? Is there any documentation or tips available?

Many thanks,
Sheila

Minihan, Brian

unread,
Jul 17, 2020, 4:22:15 AM7/17/20
to Sheila Rabun, ORCID API Users
Hi Sheila,

Can you describe which variety of 403 error you're receiving? 

this will assist in identifying what settings are incorrect.

also please make sure that you've already obtained a token via authentication with a previous interaction using https://orcid.org/oauth/authorize

I use Postman and Google Developers Playground, but here is the swagger interface site: https://swagger.io/tools/swagger-ui/

One last thing, this documentation may help constructing your API calls:

Cheers,

Brian Minihan
Engagement Lead, Asia Pacific
ORCID


--
You received this message because you are subscribed to the Google Groups "ORCID API Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to orcid-api-use...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/orcid-api-users/d9c447d3-9e0a-4658-a0de-36cb3bb63c23o%40googlegroups.com.

S.J. Rabun

unread,
Jul 17, 2020, 12:09:54 PM7/17/20
to Minihan, Brian, ORCID API Users
Hi Brian, I realized I was getting an error because I was using the link for the member API rather than https://pub.orcid.org/v3.0/ - when I used the Public API swagger it worked. With that, it seems pretty straightforward, but I do think it could be helpful if ORCID had a support page that explains what the Swagger interface is and the basics of how to use it so that we have something concrete and helpful to point to when people ask about it or when we have non-devs who want to experiment with the API - unless a page like that exists and I am just not finding it?

Thanks,
Sheila

Monica Duke

unread,
Jul 20, 2020, 8:32:45 AM7/20/20
to S.J. Rabun, Minihan, Brian, ORCID API Users

Hi Sheila,

I think for search https://github.com/ORCID/ORCID-Source/blob/master/orcid-api-web/tutorial/search.md is useful and lists the indexed fields that can be put in a search, although the list of affiliation data includes ‘affiliation-org-name, ringgold-org-id, grid-org-id’.  However I did just spot that in the table in the CSV search section suggests that ‘allowed fields’ include ’current-institution-affiliation-name’, ‘past-institution-affiliation-name’

I think the general page is also quite useful https://members.orcid.org/api/tutorial/search-orcid-registry

 

Regarding documenting these search methods, I have had for far too long on my ‘to do’ list an action to develop a tutorial covering the different existing search tools and mentioning their advantages and disadvantages.  I have this in draft form (although not updated to the more recent search features offered) and can share with you. I agree that some supplement to the tools is needed to make them more accessible to a wider audience.  Owen’s work with our UK consortium over quite a few years teasing out requirements as well as providing a quick but usable tool is part of an ongoing effort.  I have in the past got groups together for a tutorial on searching – with variable success (my approach in a small group didn’t work as well with a larger group).  Producing a ‘walk through’ for the various methods has been part of the plan for improving this space for our organisational members -  in practice the tools and methods have developed faster then I was able to get this out, so it is currently a little on the back burner.  I’d need to check it a little to confirm if its worth offering it to you offline.

 

For employment or education to be searchable, it looks like those fields would need to be indexed first, and then become allowed searchable fields.

One other factor that is part of search is which fields are returned in a search result – so you don’t need to go and fetch full record for each ORCID ID if there is summary info in the returned results – these are also useful to discuss further and identify any common needs.

 

Monica

 


Jisc is a registered charity (number 1149740) and a company limited by guarantee which is registered in England under company number. 05747339, VAT number GB 197 0632 86. Jisc’s registered office is: 4 Portwall Lane, Bristol, BS1 6NB. T 0203 697 5800.

Jisc Services Limited is a wholly owned Jisc subsidiary and a company limited by guarantee which is registered in England under company number 02881024, VAT number GB 197 0632 86. The registered office is: 4 Portwall Lane, Bristol, BS1 6NB. T 0203 697 5800.

Jisc Commercial Limited is a wholly owned Jisc subsidiary and a company limited by shares which is registered in England under company number 09316933, VAT number GB 197 0632 86. The registered office is: 4 Portwall Lane, Bristol, BS1 6NB. T 0203 697 5800.

For more details on how Jisc handles your data see our privacy notice here: https://www.jisc.ac.uk/website/privacy-notice
Reply all
Reply to author
Forward
0 new messages