Skip to content

Latest commit

 

History

History
80 lines (61 loc) · 6.1 KB

19-exploring-apis-apps.md

File metadata and controls

80 lines (61 loc) · 6.1 KB
Raw
title questions objectives keypoints
Thing 19: Exploring APIs and Apps
What are APIs?
How are APIs used with data?
Find out what they are and how they make data accessible to us all.
Get hands on to explore and use APIs relevant to research data including services offered by ANDS and the National Library of Australia.
First key point.

APIs and Apps are the engines behind making data usable.

An introduction to APIs and Apps

Apps and APIs are tools which make data much more discoverable and usable for all of us - not just researchers! You can choose to explore both APIs and Apps or just one.

Option 1: How are APIs used with data?

APIs are important for research data because they are used by developers to cleverly make data more discoverable and reusable eg. the Google Maps API is very widely used to record the exact location of a species, or photograph and lets developers embed Google Maps on webpages.

  1. Start by watching this easy, short (3.24 min) video, ‘What is an API?’
  2. Metadata records often show at least 2 different APIs in action. Interview material from Western Sydney women's oral history project: 'From farms to freeways: Women's memories of Western Sydney' metadata record shows both:
  • Google Maps API for the area map (zoom in to see the exact location where the data was collected)
  • Views and Accesses API
  1. Trove at the National Library of Australia uses APIs to showcase National Library of Australia collections in amazing ways. Check out the Trove Applications Galley to see some clever uses of Trove APIs.
  2. Just for fun: Stay in the Trove Applications Galley to find out what was making news today in history? In Trove: 5. Click on Culture Collage icon 6. then click on the On this day API icon ! {: .checklist}

Option 2: Apps for researchers and citizen scientists (is that you?)

Often several little APIs underpin a (software) App(lication) (program). Data gatherers in the field use multiple apps and APIs to make data collection easier, more accurate and more rich. eg to fill out data forms offline on their smartphones and tablets, capture images, photos, videos and sounds, track locations on maps (probably using the Google Map API), and much more. They're flexible tools that can help researchers gather more information and work faster.

Choose one or both of these links to explore:

  1. Scroll down to the list of the 10 of the Best Apps for Gathering Data in the Field. Check out uses and associated costs.
  2. Scroll down to the list of 8 Apps That Turn Citizens into Scientists - this is American but also has globally applicable apps.
  3. Consider: most of us have used public transport apps and APIs - think about the source of the data which enables real time transport information to be presented to you via an easy to read App and/or API. {: .checklist}

Discover the treasures in Trove

Get hands on with APIs and Queries. Trove is a free discovery service provided by the National Library of Australia. It provides access to millions of Australian resources including newspaper articles, images and manuscripts. The Trove API enables people to create new applications, tools and interfaces using the rich store of Trove data.

Explore the Trove

  1. Start by browsing around the Trove Application Gallery for some of the creative ways people have used the Trove API. Be inspired!
  2. To see more of the power of one API, watch this short video (3:09 min). The screen is a bit fuzzy but you can get the idea of this innovative “use your voice to query Trove” API. {: .checklist}

Consider your thoughts on how APIs could make data more exciting and accessible for more people.

Get hands on Trove

  1. Browse the introduction to the Trove API.
  2. Go the Trove API Console and click on some of the example searches provided. The results are in a machine readable format but look closely and you can see the citation details eg title, date, source, pagination
  3. Try constructing your own API query to see what results you get. Note that: If you want to use them in your own code you'll need to get an API key and add &key=[Your API key] to the url. {: .checklist}

Consider: the success of your code query - how could you get different results by varying the query?

Unleash the power of APIs

APIs and Apps are the transformation agents which make data and services powerful and accessible. These 2 options give you a chance to see how APIs can be applied to either data or services.

Option 1: Hands-on API tutorials

Are you new to APIs and want a hands-on introduction to commonly used APIs, including Twitter and YouTube?

  • Choose 1 API from the Code Academy APIs page and work through the online tutorial to learn more about the API you chose. {: .checklist}

Consider: how these APIs could be applied to a dataset to make it more re-usable?

Option 2: APIs for ANDS Services

If your institution uses ANDS services, you might want to use one or more of these APIs to enhance your services.

  1. Explore one of these APIs to get a feel for what the API does and whether it may be useful to your organization:
    • OAI PMH Provider: Use this API if your system is a harvester which is compatible with the OAI-PMH protocol
    • Research Activity Grants API: provides machine access to research activity information contributed to Research Data Australia such as grants and projects. This is a lightweight method to query the ANDS Registry for specific information about Research Activity. {: .checklist}

Consider: how these APIs could be applied to your repository