As archaeological research continues to evolve, the need for efficient access to digital resources has never been greater. At the ADS, we’re constantly looking for ways to make our vast collection of archaeological resources more accessible and useful to our diverse user base.
We’re excited to announce that we are exploring the possibility of implementing APIs (Application Programming Interfaces) for our different digital collections. But what exactly is an API, and why does it matter to you? Whether you’re a seasoned researcher, a student, or simply someone interested in archaeology, this blog post will explain how APIs could revolutionise the way you interact with ADS resources. Read on to learn more and discover how you can contribute to this exciting development.
Why We’re Exploring APIs for Archaeological Data
The ADS holds a vast collection of high quality digital resources that are offered to our users through the Archives, Archsearch and Library interfaces. The ADS encourages broad access to and use of its collections, both within the UK research community and beyond, and we are developing new ways for users to access ADS resources.
We are currently in the process of improving the ways that users access ADS collections, including updates to both ArchSearch and the ADS Library. In addition, we also want to increase the ways that our users can access ADS datasets by providing access through dedicated web services, including application programming interfaces, otherwise known as APIs.
What is an API?
An API, or Application Programming Interface, simply put, is a set of rules and protocols that allow two software programs or systems to communicate with each other. An API is like a bridge that allows software applications on your computer to communicate via the internet with data held by the ADS.
Schematic drawing of an API interface.
Some examples that you may use everyday:
- A weather app on your smartphone connects with a weather prediction website and provides a forecast based on a location or date.
- A third party application connects with a social media platform to provide analytics, such as how many people are engaging with your posts.
- A web application may use an API to allow you to sign in to their services using your Google or Facebook account.
Why are APIs useful?
There are a number of reasons why APIs could be useful for archaeological research:
- Easier access: APIS makes it easier to get the data you need directly from your own computer, without navigating through multiple web pages or interfaces.
- Time-saving automation: Use an API to set up your research tools to automatically retrieve the latest data, rather than manually downloading files each time.
- Seamless integration: Use ADS data directly in your preferred software – whether that’s statistical programs, mapping tools, or database applications.
- Customised to your needs: Build or use tools that show exactly the information you need, presented in the way that works best for your research.
- More efficient research: Spend less time on data collection and more time on analysis and interpretation.
What are the ADS proposing?
Many of our users currently access our collections through familiar web interfaces such as the Archives, ArchSearch and Library. These are known as Graphical User Interfaces (GUI). We’re planning to add new ways to access this same information through APIs, giving you more options for how you work with our data. This access will allow users to access ADS data but not update or delete existing records.
The ADS has already set up an API for OASIS, the online reporting form enabling heritage practitioners to provide information about their investigations to regional Historic Environment Records (HERs). This API allows users to programmatically access data that they have rights to on OASIS. Read more about the OASIS API on the OASIS blog.
Have Your Say – Take the API Survey
We are surveying our users to ascertain what datasets, metadata and functions would be useful to access via an API.
Who should take this survey? This survey is for all users of ADS datasets, whether you have previous knowledge of APIs or not. This survey has been designed to focus less on the technical aspects of employing an API and more on what our general user base may find useful for their work or research.
Why your input matters Even if you won’t use APIs directly, your feedback is valuable. You might benefit from tools others create using APIs, or find that your colleagues can help you access data in new ways.
The survey takes around 6-8 minutes to complete, and your input will directly influence how we develop these new services.
Take the ADS API survey today!
If you have any questions about this survey or would like to contribute any additional information please contact [email protected] using the subject line ‘API User Survey’.
