Parameterized API searches?

[Trent Yarosevich]

Greetings,

I tried making a parameterized get request as I would with a typical REST API using python's requests library, and it seems to build a URL that throws a 404 error. I can certainly call the API with a URL formatted directly to work as shown in the documentation, but this is not my preferred approach as it is less secure. Perhaps I'm doing something wrong, or this approach isn't supported? Here's a simple example:
```

base_url = 'https://doaj.org/api/search/articles/'

search_string = <search string here>
payload = {
'search_query': search_string,
'page': 0,
'pageSize': 100}

api_return = requests.get(base_url, params=payload)

```

Any insight appreciated, thanks.

best,

Trent Yarosevich

Data Extraction Analyst, IHME, University of Washington

[Richard Jones]

Hi Trent,

The trick is that the search_query parameter is part of the URL path, not a query argument.  So if you try the following URL you should get a result:

https://doaj.org/api/search/articles/medicine?page=0&pageSize=100

You can play around with this API via the swagger docs on the website, to see how the URLs are built:

https://doaj.org/api/docs#!/Search/get_api_search_articles_search_query

Cheers,

Richard

--
You received this message because you are subscribed to the Google Groups "doaj-public-api" group.
To unsubscribe from this group and stop receiving emails from it, send an email to doaj-public-a...@googlegroups.com.
To view this discussion on the web, visit https://groups.google.com/d/msgid/doaj-public-api/c9ff7c83-356b-4c9b-a04c-56c76cc0fb16n%40googlegroups.com.

--

Richard Jones, 

Founder, Cottage Labs 

https://cottagelabs.com || @cottagelabs

Blog: https://medium.com/@richard.jones

LinkedIn: https://www.linkedin.com/in/richard-jones-38893213/

[Steven Eardley]

Hi Trent,

Thanks for pointing this out, it's a little misleading on our documentation page - as Richard points out, the query string is on the URL path rather than a URL parameter. Just minor changes needed to your snippet:

import requests
from urllib.parse import quote, urljoin

base_url = 'https://doaj.org/api/search/articles/'
search_string = quote('title:micro-tensile test')

url_params = {
    'page': 0,
    'pageSize': 100
}

api_return = requests.get(urljoin(base_url, search_string), params=url_params)

print(api_return.request.url)
print(api_return.json().get('results', []))

has the following (truncated) result

https://doaj.org/api/search/articles/title%3Amicro-tensile%20test?page=0&pageSize=100
[{'last_updated': '2021-03-30T23:01:40Z', 'bibjson': {'identifier': [{'id': '10.3390/polym13071093', 'type': 'doi'}, ...

Our API currently works only via path and parameters in the URL - we don't currently support loading those from the request body, since a GET with a payload is a bit anomalous. In any case, HTTPS ensures the path and parameters are encrypted.

Cheers,
Steve

To view this discussion on the web, visit https://groups.google.com/d/msgid/doaj-public-api/CAJaHguqi0Nu-AiRPi0E_VR6q5zJysPFw8u9sA0N_3yF%3DSYfCqg%40mail.gmail.com.

-- 
Steven Eardley
Partner, Cottage Labs
https://cottagelabs.com
https://technoantics.com

[Trent Yarosevich]

Hi, thanks for the responses, they were very clear. Sounds like the way I was doing it was a bit wonky. Cheers!

best,

Trent