|
<< Click to Display Table of Contents >> Navigation: Appendix > DOI REST API Request and Response Formats > REST API Request Format |
A REST API request can be made by performing a standard HTTPS GET of /api/handles/<doiName>:
https://doi.org/api/handles/<doiName>?<param_1>&<param_2>&..
where:
•<doiName>: DOI name to be resolved
•<param_i>: parameter i passed to the DOI Proxy REST API
Example: https://doi.org/api/handles/10.1000/1?type=URL&callback=processResponse
The table below lists the parameters supported in a query sent to the DOI Proxy REST API.
Parameter |
Description |
|---|---|
callback |
Use JSONP callback (instead of CORS headers). |
pretty |
Pretty-print the JSON output. |
auth |
Authoritative query. The DOI Proxy bypasses its cache and sends its resolution request to an authoritative (primary) Handle service. |
cert |
Certified query. The DOI Proxy requires an authenticated response from the Handle service (it means that the DOI Proxy asks the Handle service to sign its response and the Proxy will check the signature before accepting it). |
index1) |
Resolve the DOI record element at the specified index and do not resolve the other elements except if explicitly required. May be repeated to resolve multiple indexes. |
type1) |
Resolve the DOI record element of the specified type and do not resolve the other elements except if explicitly required. May be repeated to resolve multiple types. |
1) The index and type query parameters can be used together: any element which matches any of the specified indexes or types is returned.