Difference between revisions of "APIs"

Latest revision as of 19:46, 11 December 2021

Finding related content

Several components can ideally display content from sources across the web. The goal is to enrich Wikimedia projects with content from the sources using the available tools. We currently read some image sources, but the content could ideally include newspapers, sounds, archival material, films, videos, literature, magazines, scientific articles etc.

The source content could be used in many ways: It could be imported as such, the metadata could be consolidated with metadata of similar objects from other outlets, or the data/metadata could be used to enrich items in Wikimedia projects. In these scenarios the open projects (Wikimedia, OSM) are seen as central databases which store the collectively enriched data and can serve that back to the institutions.

Selecting data for the query

Labels and aliases in all languages
- Not all languages can be handled by an API. The unsuitable ones need to be filtered our in the preprocessing phase.
- If the main languages of the API are known, the query can use labels of that language as a primary option.
- Preprocessing can collect all necessary values and send to the local API. The local component for a specific API can arrange the data suitable for each API, for example concatenate the query strings in different ways, using AND or OR.
Item's location can be used to narrow down search results or to distinguish from namesakes.
The dates of the item can be used to narrow down search results. This is especially useful with maps.
For maps the zoom level or the scale can be calculated using the size of the area the item covers.

Metadata roundtripping

GLAM makes available images and their metadata through their public API. Wikidocumentaries uses many Wikidata properties from the current topic to query that.
When reading the data through the Wikidocumentaries API, the metadata is normalized using a different transformation for each GLAM.
The metadata from different GLAMs is displayed in a uniform format in the Wikidocumentaries metadata display as strings.
When an image is saved to Wikimedia projects, users can reconcile string values with Wikidata items. String values can be saved as well, they will be available for reconciling later.
In the Wikidocumentaries metadata interface, the string values are replaced by reconciled Wikidata items. Differences between the source data from the GLAM and Wikidata, such as recent changes in the GLAM's metadata, can also be highlighted.
Maybe the GLAM could query Wikidocumentaries for changed information?

Consolidate data from different sources for the same item

Especially if Wikidocumentaries decides to store images or their metadata locally, these scenarios become available. Similar images from different sources can be detected. Their metadata can be compared, and the user is asked to verify the correct information. The updated data is saved in the central repository (Wikimedia Commons) with a reference to the source that provided this information. One of the information types that can be compared is the copyright status.

@@ Line 1: / Line 1: @@
-==Wikimedia==
+==Finding related content==
-===MediaWiki API===
+Several components can ideally display content from sources across the web. The goal is to enrich Wikimedia projects with content from the sources using the available tools. We currently read some image sources, but the content could ideally include newspapers, sounds, archival material, films, videos, literature, magazines, scientific articles etc.
-* https://www.mediawiki.org/wiki/API:Tutorial
+The source content could be used in many ways: It could be imported as such, the metadata could be consolidated with metadata of similar objects from other outlets, or the data/metadata could be used to enrich items in Wikimedia projects. In these scenarios the open projects (Wikimedia, OSM) are seen as central databases which store the collectively enriched data and can serve that back to the institutions.
-* https://en.wikipedia.org/w/api.php Wikipedia API help
-===Wikidata===
+==Selecting data for the query==
-* [https://query.wikidata.org/ Wikidata Query Service] - SPARQL
+* Labels and aliases in all languages
-* [https://www.wikidata.org/w/api.php Wikidata API help] - MediaWiki API
+** Not all languages can be handled by an API. The unsuitable ones need to be filtered our in the preprocessing phase.
+** If the main languages of the API are known, the query can use labels of that language as a primary option.
+** Preprocessing can collect all necessary values and send to the local API. The local component for a specific API can arrange the data suitable for each API, for example concatenate the query strings in different ways, using AND or OR.
+* Item's location can be used to narrow down search results or to distinguish from namesakes.
+* The dates of the item can be used to narrow down search results. This is especially useful with maps.
+* For maps the zoom level or the scale can be calculated using the size of the area the item covers.
-===Wikimedia Commons===
+==Metadata roundtripping==
+<gallery mode=slideshow>
+Roundtrip.png
+Roundtrip (1).png
+Roundtrip (2).png
+Roundtrip (3).png
+Roundtrip (4).png
+Roundtrip (5).png
+Roundtrip (6).png
+Roundtrip (8).png
+Roundtrip (9).png
+</gallery>
-*[https://commons.wikimedia.org/w/api.php Wikimedia Commons API help] - MediaWiki API
-==Media services==
+# GLAM makes available images and their metadata through their public API. Wikidocumentaries uses many Wikidata properties from the current topic to query that.
+# When reading the data through the Wikidocumentaries API, the metadata is normalized using a different transformation for each GLAM.
+# The metadata from different GLAMs is displayed in a uniform format in the Wikidocumentaries metadata display as strings.
+# When an image is saved to Wikimedia projects, users can reconcile string values with Wikidata items. String values can be saved as well, they will be available for reconciling later.
+# In the Wikidocumentaries metadata interface, the string values are replaced by reconciled Wikidata items. Differences between the source data from the GLAM and Wikidata, such as recent changes in the GLAM's metadata, can also be highlighted.
+# Maybe the GLAM could query Wikidocumentaries for changed information?
-=== Finna.fi ===
+==Consolidate data from different sources for the same item==
-Includes
+Especially if Wikidocumentaries decides to store images or their metadata locally, these scenarios become available. Similar images from different sources can be detected. Their metadata can be compared, and the user is asked to verify the correct information. The updated data is saved in the central repository (Wikimedia Commons) with a reference to the source that provided this information. One of the information types that can be compared is the copyright status.
-* Images from Finnish museums
-* Publications from Finnish libraries
-Documentation
+==APIs in Wikidocumentaries==
-* [https://api.finna.fi/swagger-ui/?url=%2Fapi%2Fv1%3Fswagger Finna API documentation]
+===Wikimedia APIs===
-* [https://www.kiwi.fi/display/Finna/Finnan+avoin+rajapinta Old but still somewhat useful Finna API documentation]
-* CC licensing data available, prepared for RightsStatements
-=== Flickr ===
+* '''MediaWiki API'''
-*[https://www.flickr.com/services/api/ Flick API Docs] - Includes useful API Explorer
+** https://www.mediawiki.org/wiki/API:Tutorial
+** https://en.wikipedia.org/w/api.php Wikipedia API help
-===Topothek===
+* '''Wikidata'''
-Includes
+** [https://query.wikidata.org/ Wikidata Query Service] - SPARQL
-* Images from Topotheks submitted by local people
+** [https://www.wikidata.org/w/api.php Wikidata API help] - MediaWiki API
-=== Ajapaik ===
+===Image APIs===
-[https://ajapaik.ee Ajapaik.ee]
+====In use====
-===K-Samsök===
+* '''Wikimedia Commons'''
+** [https://commons.wikimedia.org/w/api.php Wikimedia Commons API help] - MediaWiki API
+* '''Finna.fi'''
+** Images from Finnish museums
+** Publications from Finnish libraries
+** Documentation
+*** [https://api.finna.fi/swagger-ui/?url=%2Fapi%2Fv1%3Fswagger Finna API documentation]
+*** [https://www.kiwi.fi/display/Finna/Finnan+avoin+rajapinta Old but still somewhat useful Finna API documentation]
+*** CC licensing data available, prepared for RightsStatements
+* '''Europeana'''
+* '''Flickr'''
+** [https://www.flickr.com/services/api/ Flick API Docs] - Includes useful API Explorer
-===Internet Archive===
+====To be explored====
+* [https://www.programmableweb.com/api/smithsonian-institution-open-access Smithsonian Institution Open Access API]
+* [https://www.programmableweb.com/api/smk-open-rest-api-v110 SMK Open API]
+* [https://www.programmableweb.com/api/metropolitan-museum-art-met-collection Metropolitan Museum of Art Met Collection API]
+* [https://www.programmableweb.com/api/deutsche-digitale-bibliothek Deutsche Digitale Bibliothek API]
+* [https://www.programmableweb.com/api/rijksmuseum Rijksmuseum API]
+* [https://www.programmableweb.com/api/digitalnz DigitalNZ API]
+* [https://www.programmableweb.com/api/artsy-rest-api-0 Artsy REST API]
+* [https://www.programmableweb.com/api/natural-history-museum-rest-api Natural History Museum REST API]
+* [https://www.programmableweb.com/api/victoria-albert-museum-rest-api Victoria & Albert Museum REST API]
+* Paris Musées
+* [https://www.programmableweb.com/api/soch SOCH API]
+* Creative Commons Search, Openverse
+* [https://archive.org/services/docs/api/ Internet Archive]
+* [https://www.programmableweb.com/api/cleveland-museum-art-open-access The Cleveland Museum of Art Open Access API]
+* [https://ajapaik.ee Ajapaik.ee]
+* Topothek
+* [https://pro.dp.la/developers/api-codex DPLA]
+* Structured Data on Commons
+* [https://www.loc.gov/apis/ Library of Congress]
-==Data==
+===Data APIs===
+====To be explored====
+* '''Nimiarkisto.fi'''
+* '''Linked Data Finland'''
+** [https://colab.research.google.com/drive/1scxCJl-w0Fsq_cn1cI1gwIhUk9DLA4K4?usp=sharing BiographySampo]
+** SotaSampo
+* '''FIN-CLARIN'''
-=== Nimiarkisto.fi ===
+===Map APIs ===
+====To be explored====
+* '''Map Warper'''
+** [https://github.com/timwaters/mapwarper/blob/master/README_API.md Map Warper API documentation]
+* Library of Congress
-=== Linked Data Finland ===
+==Wikimedia integrations==
-* BiographySampo
+* Wikisource
-* SotaSampo
-=== FIN-CLARIN ===
-==Map services ==
-=== Map Warper ===
-*[https://github.com/timwaters/mapwarper/blob/master/README_API.md Map Warper API documentation]
-==Design files==
-* https://www.figma.com/files/project/891845/Wikidocumentaries
-== Misc. ==
-===Images===
-* For the federated API query to be able to search
-** Name of the topic, time, location as coordinates or address, existing authority IDs (Eg YSO), alternative names, language variants...
-===Digitized maps===
-* Date
-* Historical administrative entities
-* Source
-* [https://stackoverflow.com/ Stack Overflow] - Developer Community Q&A & knowledge sharing
 {{design-nav}}

Difference between revisions of "APIs"

Latest revision as of 19:46, 11 December 2021

Contents

Finding related content

Selecting data for the query

Metadata roundtripping

Consolidate data from different sources for the same item

APIs in Wikidocumentaries

Wikimedia APIs

Image APIs

In use

To be explored

Data APIs

To be explored

Map APIs

To be explored

Wikimedia integrations

Navigation

Navigation menu

Search