search

gbif / hosted-portals

Support material for establishing the GBIF Hosted Portals
Apache License 2.0
10 stars 6 forks source link

Toolbar with link to API usage #66

Open MortenHofft opened 3 years ago

MortenHofft commented 3 years ago

A part of the original vision for these widgets was to expose the API more. The suggested version was to add a link to all pages showing how to use the content using the APIs.

tucotuco commented 3 years ago

I don't know to what extent there is overlap with one of our wish list items, which would be to see the API call that was made for a given search. This would have immense utility in understanding how to use the API.

MortenHofft commented 3 years ago

Hi @tucotuco this issue was created in a response to a mail from Vertnet. So I'm glad to hear that you also think it is related :)

As for understanding the API, do you mean by users or you as a site owner?

The intention of this issue is to create a link on all pages, that redirects users to the relevant API documentation. and possible a direct link that reflect the core search query (all pages of course do a ton of queries, but there is typical a central one that we could highlight).

I imagine a little - hopefully omni precent - {API}-icon that opens a drawer with an example and some links to the relevant parts of the documentation. With the intention to draw attention to the API and secondly give users an easier start with it.

Sad story: we still see users that write crawlers to get the data.

tucotuco commented 3 years ago

Hi @tucotuco this issue was created in a response to a mail from Vertnet. So I'm glad to hear that you also think it is related :)

As for understanding the API, do you mean by users or you as a site owner?

The intention of this issue is to create a link on all pages, that redirects users to the relevant API documentation. and possible a direct link that reflect the core search query (all pages of course do a ton of queries, but there is typical a central one that we could highlight).

I imagine a little - hopefully omni precent - {API}-icon that opens a drawer with an example and some links to the relevant parts of the documentation. With the intention to draw attention to the API and secondly give users an easier start with it.

Fabulous.

Sad story: we still see users that write crawlers to get the data.

Not fabulous.