Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

ORCID API Perks & Pitfalls

324 views

Published on

Presented by ORCID Developers at ORCID's October 2016 Outreach Meeting.

Published in: Education
  • Be the first to comment

ORCID API Perks & Pitfalls

  1. 1. DEVELOPERSDIVULGE… ORCIDAPIPerks+Pitfalls
  2. 2. Wasitbuiltbyrobots? THEORCIDAPI... ...ordroppedbyaliens?
  3. 3. No,it’smadebypeople! ...peoplewhoknowitsdarkestsecrets JEFF Angel
  4. 4. Whatisthisabout? Opportunitytogaininsightsintohowthe ORCIDteamthinks. Nothinginthisisofficial. Shouldbefun!Goodhumordebatesare welcome,butdon’tbeabully.
  5. 5. PITFALL Citationmetadatainmetadata! Perhapsweshouldgetridofcitation metadatainsidemetadata? P.S.thisisreal-----------------> (anditcanbeanything!?!?!?!)
  6. 6. SPEAKINGOFCITATIONS……. BibTeX! NoUTF8,helloit’sthe21stcentury Toomanydifferentbibteximplementations LaTexparsersareanislandoftheirown.
  7. 7. PITFALL Uselesscoauthors! Perhapsweshouldgetridof contributormetadatainworks? Itgoeson,andon,andon.718 coauthornamesinthisexample-->
  8. 8. PITFALL Hyper-authors Currenttop47,921works…. 14Authorswithmorethan2000works
  9. 9. PERK V2.0+Summaries HasLastmodifiedtimestampsforItems Hierarchicaltimestamps Containstheidentifiers
  10. 10. PITFALL Batch-createorcidrecords Unclaimedrecords Hardtocorrecterrors Userconfusion
  11. 11. PERK Create-on-demand Easierthanbatchcreate - mailmerge emailw/custom urlforeachuserpre-fills theregistration form!
  12. 12. PITFALL GettingauthenticatediDsintosystemsthat Don’tinteractw/authors (repositories,authorityfiles…)
  13. 13. PERK Sorry.ResearchercontrolisacoreORCID principle...butthereareMultiplewaystoget authenticatediDs! (free!)Publicapi(canyousendanemail?) (new)Institutionalsign-in:RequestiDwhen userssignintoORCIDviayoursystem
  14. 14. PERK Easytounderstanderrormessages +suggestederrorstoshow users <developer-message>... Invalid content was found starting with element 'common:external-id-relationship'. One of '{"http://www.orcid.org/ns/common":external-id-value}' is expected.]</developer-message> <user-message>ORCID could not process the data, because they were invalid.</user-message> <error-code>9001</error-code>
  15. 15. PITFALL Unexpectederrorshaveunhelpfulmessages <!DOCTYPE html><html><head><title>Apache Tomcat/8.0.21 - Error report</title><style type="text/css">H1 {font-family:Tahoma,Arial,sans- serif;color:white;background-color:#525D76;font-size:22px;} H2 {font- family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font- size:16px;} H3 {font-family:Tahoma,Arial,sans-serif;color:white;background- color:#525D76;font-size:14px;} BODY {font-family:Tahoma,Arial,sans- serif;color:black;background-color:white;} B {font-family:Tahoma,Arial,sans- serif;color:white;background-color:#525D76;} P {font-family:Tahoma,Arial,sans- serif;background:white;color:black;font-size:12px;}A {color : black;}A.name {color : black;}.line {height: 1px; background-color: #525D76; border: none;}</style> </head><body><h1>HTTP Status 403 - Access Denied</h1><div class="line"></div><p><b>type</b> Status report</p><p><b>message</b> <u>Access Denied</u></p><p><b>description</b> <u>Access to the specified resource has been forbidden.</u></p><hr class="line"><h3>Apache Tomcat/8.0.21</h3></body></html>
  16. 16. PITFALL Gettingusefulerrorstousers(andletting themknowwhotocontactforHelp) ↑Misconfiguredcodeexchange Tryingtosendbadmetadata ↓
  17. 17. PITFALL PollingthepublicAPI Makesourserverstired Toofast/toomuchdata= wethinkyou’readosattack
  18. 18. perk Wehaveotherwaystogetrecordupdates! Webhooks SearchAPI(searchbylastmodifieddate) on-demandpublicdatadump (comingsoon!)
  19. 19. PITFALL PublicDatadump Usesalotofresources Upsetourpublicapiservers Wrongarchitecture wrongformat /xml->+2.5Mfiles /json->+2.5 Mfiles
  20. 20. perk* On-demanddatadump Realtime Abilitytosync Shardingstructure SyncJSON,XMLorboth Support1.2and2.0(Latest RC) *comingsoon
  21. 21. perk Bulkcreateforworks! Allowmemberstocreateupto100worksper request valid/non-dupworksareadded Invalid/dupworksbecomeserrorelements
  22. 22. PITFALL It’sreallyhardtoaddnewworkidtypes They’rehardcoded! Peopleworkwithothers,butnobodymodelsit Project&GrantIDsarecrappytoo! Whatifmineisn’t inthislist?!
  23. 23. PERK We’vefixedexternalIDtypesinv2.0 API andwillenablecommunitycontributions tothevocab ProjectTHORisworkingonIDcollections includingprojectIDsandgrantIDs!
  24. 24. PERK StableandReleaseCandidate versions Enterprisesystemsonlyhavetoupdate~1year Fastmovingclientscankeepupwiththelatest andgreatest
  25. 25. PITFALL Allofthiscanbehardtounderstand ManypartstotheORCIDRecordandAPI Organizationsfromdifferentsectorswith differentgoalshavetousethesameAPI
  26. 26. PERK It’salloutthere We’reopensource-youcancontribute LotsofDocumentation Technical detailsonGitHub Workflows,tutorial,andmoreatmembers.orcid.org
  27. 27. PERK Thereishelp APIUserGroup Personalresponsesatsupport@orcid.org Fixbugsindays,criticalbugswithinhours UserFeedbackleadstonewfeatures
  28. 28. RobertPetersr.peters@orcid.org WillSimpsonw.simpson@orcid.org LizKrznariche.krznarich@orcid.org AngelMontenegroangel.montenegro@ost.orcid.org CatalinaWilmersc.wilmers@orcid.org TomDemeranville t.demeranville@orcid-eu.org Jeersorcheers?

×