BETA

Skip links

  • Skip to primary navigation
  • Skip to content
  • Skip to footer
Queensland government logo Queensland government logo
Sign in Sign out
Sign in
  • Profile summary
  • Sign out
Department of Education Department of Education Developer Portal
  • Home
  • Tags
  • Chat
  • Beta
    APIs
  • Help
  • Contact us
  • Dark mode
  • Home
  • Tags
  • Chat
  • Beta
    APIs
  • Help
  • Contact us
  • My profile
  • Dark mode

API basics: What they are and how they work

Jeny Amatya Government Popular Admin
by Jeny Amatya
11 September 2025
Last updated 15 September 2025
API Getting started
API Getting started

What is an API?

An API (Application Programming Interface) is a standard way for two software systems to communicate with each other in a safe, consistent and controlled manner. You can think of it as a bridge between your application and another system, or like a waiter in a restaurant.

The waiter takes your order (or request), communicates it to the kitchen (the system providing the service) and finally, delivers the food (or response from the system) back to your table.

Restaurant analogy

An API acts as a messenger that:

  • receives a request from your application
  • passes that request to the appropriate system
  • returns the response back to your application.

API workflow

How do APIs work?

The process can be summarised in three steps:

  1. Send a request Your application sends a request to a specific API requesting the data or action required.

  2. Process the request The API validates your request (using your application key), then retrieves the relevant data or performs the requested action.

  3. Receive the response The API returns the result in a standard format (typically JSON) that your application can use.


Examples

Mobile weather app

  1. Send a request: To local weather API: Give me the local weather forecast for [location].
  2. Process the request: The local weather API validates the request and sends back the requested data.
  3. Receive the response: The mobile weather app receives the data from local weather API and displays the data for the user.

Class attendance roll

  1. Send a request: To attendance API: Give me a list of all the students who are present in year 4 today.
  2. Process the request: The attendance API validates the request and sends back the requested data.
  3. Receive the response: Your app receives data from the attendance API which lists all the students in year 4 who are present today.

Why use APIs?

APIs make it easy to:

  • access up-to-date, accurate data
  • save time because there’s no manual data entry needed
  • build apps and dashboards that update automatically.

Next steps

  • Learn how to authenticate using your application key
  • See code examples for Node.js, Python, C# and curl
  • Test your first call in our API sandbox - a safe place to experiment
Powered by Link to AI chat
  • Copyright
  • Disclaimer
  • Privacy
  • Right to information
  • Accessibility
  • Jobs in Queensland Government
  • Other languages

© The State of Queensland (Department of Education) 2025

Queensland Government