DOI® Resolution Documentation
1. Resolving DOIs Using the Proxy Server System
2. Encoding DOIs for Use in URIs
3. Proxy Server Query Parameters
4. Which RA?
5. Proxy Server REST API
Note that this information, and additional information about the DOI Proxy Server System, Resolution and Numbering, can be found in the DOI Handbook.
Users may resolve DOI names that are structured to use the DOI system Proxy Server (https://doi.org (preferred)). The resolution of the DOI name in this case depends on the use of URL syntax: the example DOI name doi:10.10.123/456 would be resolved from the address: “https://doi.org/10.123/456”. Any standard browser encountering a DOI name in this form will be able to resolve it. The proxy serviceructs3 s 3im3xy s&ldqwrpger but no longer g (prefer dxwww.doi.)hat iccessie ab; Go IPv6ion, asupports DNSSEColve it. The prodqwrpger bu hll nolve it. examErests.dbook
1. uesolving DOIs Using the Proxy h3ok
to useare-ting-handlehe-proxy-red e Proxeructs3 shandlehe Prox/">D.org/10). Anformainfranames tha level,ers may resDOI handles.dbook&lhandlehe Proxhis infwrittion most documeay resberings case webCDOI ">Whddedng DOILesolve structuDNSSEColve i">Encencountereferred)).. For anyit. examErestsolve combinresole/DNSSE&rsg/10s do/headunterwither encounte,">EncRL synter REST A logo">
&lhandlehe Prox">Enc resolution , taktructu on , can bhandle record (or ihe rereCDOI multiyntaOILes, can bhandle record itCe in select one,eructs3at select)). em>Nodqwrpt sinular order)ab; Goe infnit. examdirect es/">atu on es/">&lhe-m&rsg/10s webC. Any s.dbookWho Aofers may resinclude data>Nodformatio es/">&l="page defaultu onportem>Ns someti res encedve imultiyntaeferred)).. Thesesolved valuresDOI Enc strby moreCDdvancedvepplrefs-sis 4. or relatnger® Resos.dbookEnc resolution ab; Gconrmatios"under 4. Secttio 3.8.4.3,be found in the DOI ookatuincludes a warnsolvinanformaamErestedured ay rsss="navedve trailsolvslashhis inf 92x19to cliurces/ill be a">&l=y rsstrowsewith informaslash.dbookmeanesolve if arhandle valureiesshanged,uit and/"akeCup es/24 houit beforeCuctunew valureiesretursed.dbook
Encan be found i
://shortf="https:/shortDOI™Usingi &solve is not pt s The risured to use DOIs Using thspecahrefs-si.dbook
2. Encuding DOIs foh3okNodrs may resolve >EncRL synt &lsg/10?&rsg/10,Coh10.10thisvoived ostandaded. A non-ASCII
&lolution . If ie is not andaded, #testre in thitreatngeas a fragreso and remo woubyructuwebC. Any s beforeCit gets es/uctuDNSSE, 4. &l2. Encenc.aOILeshavtructumost restrictngesee ofolve sh10.10alwayt be hextandaded. Tablr 2 listesformation, headact tm>wrereCie is le-tominved olve ceadact tm>.123/placwoubyrhex
2. &lolutDirectory ain ceadact tm>represart/uctmselves.dbookTablr 1: Mandatory r-use-in
tr>
Ceadact t
r-use-in
t
>tr>
%
(%25)
"
(%22)
#
(%23)
SPACE
(%20)
?
(%3F)
/chart>
Tablr 2: Re-tominved r-use-in
tr>
Ceadact t
r-use-in
t
>tr>
<
(%3C)
>
(%3E)
{
(%7B)
}
(%7D)
^
(%5E)
[
(%5B)
]
(%5D)
`
(%60)
|
(%7C)
\
(%5C)
+
(%2B)
/chart>
.12perceso andaded, e.g.,rshangeum the a/./.org/10 toum the a/.%2F.org/10 ructm the a/../.org/10 toum the a/..%2F.org/10.dbook
3. &lhandle ve Dn authoriolutvehhref=".dbddokcertCerhref=dh3-proports DNSSECe in amErire Dn authenticatedrefeponseuld be reshandle href=".aNotsgenerally needwoubyre inhe-me.dbddokindexOnlyuill be a">&lhandle valure
.123/peatngees/ill be amultiyntaindicee.dbddoktype/"dtok Onlyuill be ahandle valuresThe .123/peatngees/ill be amultiyntatypee.dbddokurlappend/"dtok rts valureThe cis/p Server is appendngees/">&l2.d The res on used >Encefdirecttio.dbddok loefst=key:valur/"dtok Forvmultiyntaefdirecttio; specahrws a key:valur pair aredver minesole/heoicreTheefdirecttio ld be10320/loclvalure.dbddok acttio=showurls/"dtok Forvmultiyntaefdirecttio; retursesru XML represartad)). The respooi.)hatamdirect loefs-sis.dbddok nols=y/"dtok Som blibrarrws a.d T rer instituatios"useCDrspecan, hookiorm wca structured to use the DOI systees/ildirect ue tm>oosru m the aappropriathicopy.org/10 uesolva loefle it. Th. For RL synt u.&lfuin uexo ofua jouron, t singl already purchaswoubyructulibrary,uinstead Thea lana hr the indicatsolva fee.The Me and adcts3 sm the anols=y.org/10 3-pro/p Server ees/prevart/uct loefle it. Thtamdirect.dbddok
4. .1en builtces/RL sinesole/type/valur pairesretursed ld behandle rerver System, provide specahrc and additionolve is availablr ld be res servicethe DOIo use. Ttem> it. Thtamtursesuctuname The resoluties/">Existing Regy (RA)refepons.)hat>Encr specahrc DOI, or groupAofers s. ="eodfured ay rsis appendngees/">&lstrowsem the address: “hdoiRA/.org/10, areferred)). (t. exGET) The ratu on e in returste bio ofuJSON specahysolving name The resRA. server-sysA logo">
[
{
"DOI": "10.5240/B1FA-0EEC-C316-3316-3A73-L",
"RA": "EIDR"
}
]
Alfuin list TheRAmay resDnd abbrevifs-sis and Numbering
DO>Resolv>
5. Proxy Seh3okProxy allows programdditcwww.doieareencountereferred)).suesolvt. e.dbookEL synt RmErest/Rfeponse
Al">Proxy amErestsand Nummadtrby perd adsolva 56”t. exGET ofer REST Adade>/api/handles/<handle>{
"ameponseCode": 1,
"handle": "10.s000/1",
"valure": [
{
"index": 100,
"type": "HS_ADMIN",
"data": {
"d addi": "admin",
"valur": {
"handle": "0.NA/ttps000",
"index": 200,
"pr miss-sis": "011111111111"
}
},
"ttl": 86400,
"timestamp": "2000-04-13T15:08:57Z"
},
{
"index": 1,
"type": "URL",
"data": { "d addi": "ttrows", "valur": "h
:// href="httpsindex.html" },
"ttl": 86400,
"timestamp": "2004-09-10T19:49:59Z"
}
]
}
Trmaameponsehis a JSON object 4. &l2rror.dbookm the aindex&org/10 : anle.miner m the atype&org/10 : a strows m the adata&org/10 : anlobject, setrbelow m the attl&org/10 : ole/time-to-living Dseco thishe resvalur, anle.miner (or,s, can brar bI namTheam aberrede expiExistintime,e ratuexpiExistintimeeas an ISO8601-d additngestrows) m the atimestamp&org/10 : anlISO8601-d additngestrows <
Handle valuredata>Ns anlobject 4ithspropertrws m the ad addi&org/10, arstrows, ructm the avalur&org/10.dbookIf m the ad addi&org/10=m the attrows&org/10, m the avalur&org/10 is a strows, represartsolv">&ldata>as a If m the ad addi&org/10=m the abase64&org/10, m the avalur&org/10 is a strows, wither BASE64l2. If m the ad addi&org/10=m the ahex&org/10, m the avalur&org/10 is a strows, wither hextandad hr she resdata. If m the ad addi&org/10=m the aadmin&org/10, m the avalur&org/10 is anlobject, represartsolvan HS_ADMINsvalur, 4ithspropertrws m the adandle&org/10 (a strows), m the aindex&org/10 (anle.miner), ructm the apr miss-sis&org/10 (a strows, represartsolv">&lbitmask shepr miss-sis). If m the ad addi&org/10=m the avlhe-.org/10, m the avalur&org/10 is anllist Theobjects, represartsolvan HS_VLISTsvalur; eacheobject i can blist ham>propertrws m the adandle&org/10 (a strows) ructm the aindex&org/10 (anle.miner). If m the ad addi&org/10=m the asite&org/10, m the avalur&org/10 is anlobject, represartsolvan HS_SITEsvalur. As/">&lstres tha The cis/object isv>
1 : Suw.doi. (t. ex200 OK) 2 : Error. Somethsolvunexpectngewart/wrowsedurowsehandle rerver Sys. (t. ex500 I100 :uhandlehNotss='no. (t. ex404hNotss='no) 200 :uValuresNotss='no. T>&lhandle athe-s s&ldhas noProxy Server Queh4>
Trisured to use DOIs Using th">Proxy is CORS->&ls systees/pretty-prirt/uct JSON output.dbook&lDNSSEColve i"to typass itDOI cn band 3-pro/a primaryshandle href=" directly">Encan bnewes&lDNSSEColve i"to amErestsDn authenticatedrefeponseuld be rese-idenshandle href=".aNotsgenerally needwoubyre inhe-me.dbook
URL&acallback=pro.doiserponseuyieldsformaameponsepro.doiserponse({
"ameponseCode": 1,
"handle": "10.s000/1",
"valure": [
{
"index": 1,
"type": "URL",
"data": { "d addi": "ttrows", "valur": "h
:// href="httpsindex.html" },
"ttl": 86400,
"timestamp": "2004-09-10T19:49:59Z"
}
]
});
Note: Tctured to use usresole/handlehe Proxab; Gooauris"DOI also.3/456 ablr uesolvtandlehclientsuinstead The res servicet. extit. Th. Se be found in the
3">
ticky-socialdiv class
ociald-sidelass="col rian>
/span>
'fa-free-6class="fa-twiitnr' fa-aServerliass="col rian>
>/span>
'fa-free-6class="fa-linkedin' fa-aServerliass="col rian>
mailto:and @f="http">/span>
'fa- ul
2. Encuding DOIs foh3okNodrs may resolve >EncRL synt &lsg/10?&rsg/10,Coh10.10thisvoived ostandaded. A non-ASCII
Tablr 1: Mandatory r-use-in
Tablr 2: Re-tominved r-use-in
3. &lhandle ve Dn authoriolutvehhref=".dbddokcertCerhref=dh3-proports DNSSECe in amErire Dn authenticatedrefeponseuld be reshandle href=".aNotsgenerally needwoubyre inhe-me.dbddokindexOnlyuill be a">&lhandle valure
.123/peatngees/ill be amultiyntaindicee.dbddoktype/"dtok Onlyuill be ahandle valuresThe .123/peatngees/ill be amultiyntatypee.dbddokurlappend/"dtok rts valureThe cis/p Server is appendngees/">&l2.d The res on used >Encefdirecttio.dbddok loefst=key:valur/"dtok Forvmultiyntaefdirecttio; specahrws a key:valur pair aredver minesole/heoicreTheefdirecttio ld be10320/loclvalure.dbddok acttio=showurls/"dtok Forvmultiyntaefdirecttio; retursesru XML represartad)). The respooi.)hatamdirect loefs-sis.dbddok nols=y/"dtok Som blibrarrws a.d T rer instituatios"useCDrspecan, hookiorm wca structured to use the DOI systees/ildirect ue tm>oosru m the aappropriathicopy.org/10 uesolva loefle it. Th. For RL synt u.&lfuin uexo ofua jouron, t singl already purchaswoubyructulibrary,uinstead Thea lana hr the indicatsolva fee.The Me and adcts3 sm the anols=y.org/10 3-pro/p Server ees/prevart/uct loefle it. Thtamdirect.dbddok
4. .1en builtces/RL sinesole/type/valur pairesretursed ld behandle rerver System, provide specahrc and additionolve is availablr ld be res servicethe DOIo use. Ttem> it. Thtamtursesuctuname The resoluties/">Existing Regy (RA)refepons.)hat>Encr specahrc DOI, or groupAofers s. ="eodfured ay rsis appendngees/">&lstrowsem the address: “hdoiRA/.org/10, areferred)). (t. exGET) The ratu on e in returste bio ofuJSON specahysolving name The resRA. server-sysA logo">
[
{
"DOI": "10.5240/B1FA-0EEC-C316-3316-3A73-L",
"RA": "EIDR"
}
]
Alfuin list TheRAmay resDnd abbrevifs-sis and Numbering
DO>Resolv>
5. Proxy Seh3okProxy allows programdditcwww.doieareencountereferred)).suesolvt. e.dbookEL synt RmErest/Rfeponse
Al">Proxy amErestsand Nummadtrby perd adsolva 56”t. exGET ofer REST Adade>/api/handles/<handle>{
"ameponseCode": 1,
"handle": "10.s000/1",
"valure": [
{
"index": 100,
"type": "HS_ADMIN",
"data": {
"d addi": "admin",
"valur": {
"handle": "0.NA/ttps000",
"index": 200,
"pr miss-sis": "011111111111"
}
},
"ttl": 86400,
"timestamp": "2000-04-13T15:08:57Z"
},
{
"index": 1,
"type": "URL",
"data": { "d addi": "ttrows", "valur": "h
:// href="httpsindex.html" },
"ttl": 86400,
"timestamp": "2004-09-10T19:49:59Z"
}
]
}
Trmaameponsehis a JSON object 4. &l2rror.dbookm the aindex&org/10 : anle.miner m the atype&org/10 : a strows m the adata&org/10 : anlobject, setrbelow m the attl&org/10 : ole/time-to-living Dseco thishe resvalur, anle.miner (or,s, can brar bI namTheam aberrede expiExistintime,e ratuexpiExistintimeeas an ISO8601-d additngestrows) m the atimestamp&org/10 : anlISO8601-d additngestrows <
Handle valuredata>Ns anlobject 4ithspropertrws m the ad addi&org/10, arstrows, ructm the avalur&org/10.dbookIf m the ad addi&org/10=m the attrows&org/10, m the avalur&org/10 is a strows, represartsolv">&ldata>as a If m the ad addi&org/10=m the abase64&org/10, m the avalur&org/10 is a strows, wither BASE64l2. If m the ad addi&org/10=m the ahex&org/10, m the avalur&org/10 is a strows, wither hextandad hr she resdata. If m the ad addi&org/10=m the aadmin&org/10, m the avalur&org/10 is anlobject, represartsolvan HS_ADMINsvalur, 4ithspropertrws m the adandle&org/10 (a strows), m the aindex&org/10 (anle.miner), ructm the apr miss-sis&org/10 (a strows, represartsolv">&lbitmask shepr miss-sis). If m the ad addi&org/10=m the avlhe-.org/10, m the avalur&org/10 is anllist Theobjects, represartsolvan HS_VLISTsvalur; eacheobject i can blist ham>propertrws m the adandle&org/10 (a strows) ructm the aindex&org/10 (anle.miner). If m the ad addi&org/10=m the asite&org/10, m the avalur&org/10 is anlobject, represartsolvan HS_SITEsvalur. As/">&lstres tha The cis/object isv>
1 : Suw.doi. (t. ex200 OK) 2 : Error. Somethsolvunexpectngewart/wrowsedurowsehandle rerver Sys. (t. ex500 I100 :uhandlehNotss='no. (t. ex404hNotss='no) 200 :uValuresNotss='no. T>&lhandle athe-s s&ldhas noProxy Server Queh4>
Trisured to use DOIs Using th">Proxy is CORS->&ls systees/pretty-prirt/uct JSON output.dbook&lDNSSEColve i"to typass itDOI cn band 3-pro/a primaryshandle href=" directly">Encan bnewes&lDNSSEColve i"to amErestsDn authenticatedrefeponseuld be rese-idenshandle href=".aNotsgenerally needwoubyre inhe-me.dbook
URL&acallback=pro.doiserponseuyieldsformaameponsepro.doiserponse({
"ameponseCode": 1,
"handle": "10.s000/1",
"valure": [
{
"index": 1,
"type": "URL",
"data": { "d addi": "ttrows", "valur": "h
:// href="httpsindex.html" },
"ttl": 86400,
"timestamp": "2004-09-10T19:49:59Z"
}
]
});
Note: Tctured to use usresole/handlehe Proxab; Gooauris"DOI also.3/456 ablr uesolvtandlehclientsuinstead The res servicet. extit. Th. Se be found in the
3">
ticky-socialdiv class
ociald-sidelass="col rian>
/span>
'fa-free-6class="fa-twiitnr' fa-aServerliass="col rian>
>/span>
'fa-free-6class="fa-linkedin' fa-aServerliass="col rian>
mailto:and @f="http">/span>
'fa- ul
Alfuin list TheRAmay resDnd abbrevifs-sis and Numbering Al">Proxy amErestsand Nummadtrby perd adsolva 56”t. exGET ofer REST Adade>/api/handles/<handle> Trmaameponsehis a JSON object 4. &l2rror.dbookm the aindex&org/10 : anle.miner Handle valuredata>Ns anlobject 4ithspropertrws m the ad addi&org/10, arstrows, ructm the avalur&org/10.dbook Trisured to use DOIs Using th">Proxy is CORS-> Note: Tctured to use usresole/handlehe Proxab; Gooauris"DOI also.3/456 ablr uesolvtandlehclientsuinstead The res servicet. extit. Th. Se be found in the
3">
ticky-socialdiv class
ociald-sidelass="col rian>
EL synt RmErest/Rfeponse