This microservice .
$ virtualenv python
$ source python/bin/activate
$ pip install -r requirements.txt
$ pip install -r dev-requirements.txt
$ vim local_config.py # edit, edit
On your desktop run:
$ py.test
To resolve references, edit test_reference_service.py and add authorization token.
Next run the script with either one reference per line
$ python test_reference_service.py "Adler, I., et al. 1972, Science, 175, 436
Anders, E. 1989, Nature, 342, 255"
or have list of text refernces in a file, which shall send the maximum number of references that servcie accepts, 16, to servcie and the result to the console.
$ python test_reference_service.py -i <input filename>
To make a GET request with a reference string which returns the score and resolved bibcode do,
curl -H "Authorization: Bearer <your API token>" -X GET https://dev.adsabs.harvard.edu/v1/reference/text/<reference>
For example, to resolve the reference Giraud et al., 1986, A&A, 170, 1, you would do
curl -H "Authorization: Bearer <your API token>" -X GET https://dev.adsabs.harvard.edu/v1/reference/text/Giraud%20et%20al.%2C%201986%2C%20A%26A%2C%20170%2C%201
which returns the confidence score, followed by the resolved bibcode, and includes the requested text reference:
{"resolved": "0.9 1986A&A...170....1G -- Giraud et al., 1986, A&A, 170, 1"}
To return the result as fielded json, include Accept: application/json in the header. For example
curl -H "Authorization: Bearer <your API token>" -H "Accept: application/json" -X GET https://dev.adsabs.harvard.edu/v1/reference/text/Giraud%20et%20al.%2C%201986%2C%20A%26A%2C%20170%2C%201
which returns,
{"resolved": {"score": "0.9", "bibcode": "1986A&A...170....1G", "refstr": "Giraud et al., 1986, A&A, 170, 1"}}
To make a POST request, list text references in an array in the following format,
{"reference":["<text_reference1>","<text_reference2>", ...]}
and call the end point text:
curl -H "Authorization: Bearer <your API token>" -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"reference":["Giraud et al., 1986, A&A, 170, 1"]}' https://api.adsabs.harvard.edu/v1/reference/text
The API then responds in JSON and returns the resolved references in the following format:
{"resolved": [{"refstring": "Giraud et al., 1986, A&A, 170, 1", "score": "1.0", "bibcode": "1986A&A...170....1G"}]}
Note that there is a 16 references limit per POST request.
To make a POST request, list parsed references in an array in the following format,
{"parsed_reference":[{<parsed_reference1>},{<parsed_reference2>}, ...]}
and call the end point xml:
curl -H "Authorization: Bearer <your API token>" -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d {"parsed_reference":"[{'authors': 'nielsen', 'journal': 'Quantum Computation and Quantum Information', 'year': '2000', 'refplaintext': 'Quantum Computation and Quantum Information nielsen 2000'}]"} https://api.adsabs.harvard.edu/v1/reference/xml
Similar to the POST request to resolve text references, list them in an array, and call the end point parse:
curl -H "Authorization: Bearer <your API token>" -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"reference":["Giraud et al., 1986, A&A, 170, 1"]}' https://api.adsabs.harvard.edu/v1/reference/parse
The API then responds in JSON the parsed references in the following format:
{"parsed": [{"authors": "Giraud et al.", "year": "1986", "volume": "170", "page": "1", "journal": "A&A", "refstr": "Giraud et al., 1986, A&A, 170, 1"}]}
Golnaz