- Previous: Getting started using the Springer API portal
- Up: Getting started using the Springer API portal
- Next: Querystring parameters
Restful operations
The Springer API supports a number of different operations and return formats. These can be controlled by issuing RESTful requests to the API service at http://api.springer.com.
Requests must always include both a Collection and a ResultFormat. The Collection identifies what respository should be searched for results and the ResultFormat indicates how data should be returned by the API. For example, in this request:
http://api.springer.com/metadata/pam/doi/10.1007/s11276-008-0131-4?api_key=yourKeyHere
The first bold element is the Collection and the second is the ResultFormat. In this case the metadata repository is being searched and the resulting metadata should be returned in pam format. Allowable values for these parameters are listed in the table below:
| Collection | Description | ResultFormat | Description |
| metadata |
Stores journal articles and book chapters | pam | Returns XML results with each record in PRISM Aggregator Message format (*with some additional journal- or book-specific fields not covered by PAM at this time [e.g., openAccess]) |
| json | Returns JSON formatted results | ||
| jsonp | Returns JSON formatted results with padding | ||
| images | Stores image information from articles and books | xml | Returns XML results |
| json | Returns JSON formatted results | ||
| jsonp | Returns JSON formatted results with padding | ||
| openaccess |
Stores open access content |
app | Returns XML data in Springer's A++ format |
| json | Returns JSON formatted metadata results | ||
| jsonp | Returns JSON formatted metadata with padding |
In the above example the third part of the URI path doi is a short-hand method of requesting metadata for a single article. It is equivilent to doing a query for a single DOI using the q parameter:
http://api.springer.com/metadata/pam?q=doi:10.1007/s11276-008-0131-4&api_key=yourKeyHere
| method | description |
| doi | Find a single article based on the DOI |
| issn | Find a set of articles in a single Journal ISSN |
| isbn | Find a set of chapters in a single Book ISBN |
More complex requests can be made using querystring parameters. For further information on these read the next section.
9 Comments
P. Ferreira – 2 years ago
All fine for me!
This is a great API! :D
Fazil Hasan – 2 years ago
APIs is working but needs to have some improvements....
MARIA LORNA KUNNATH – 2 years ago
DOES NOT WORK :-<
Eddie – 2 years ago
Yes, we had some issues over the weekend that have now been resolved by development. Should work now.
Eddie
Mohamed Barakat – 2 years ago
it does not work
foobarX – 1 year ago
How can I get the keywords associated with each article? The facets that I get returned from the query apply to the entire results, right (not just the batch of 10 I am looking at)?
foobarX – 1 year ago
I'm pretty sure the facets DO apply to the AGGREGATE - which is strange, since that means it is retransmitted each time (e.g. looking at 10 at a time through a 1000 articles - it looks like it would be significant overhead redundantly) - am I missing something? thx
Eddie – 1 year ago
Yes, they reply to the entire result. But you can query of course by DOI and get the keywords that apply to that DOI, e.g., http://api.springer.com/metadata/pam?q=doi:10.1007/s11883-010-0103-x&api_key=[KEY]
Eddie
foobarX – 1 year ago
Seems like you could hit the 5k daily limit pretty easily needing to do an individual query each time
Please sign in to post a comment.