Understand the API design principles – digital guide
Understand our API Design Standards for building an interoperable API and discover our API Gateway and portal.
On this page
- What’s an API?
- What do we recommend?
- Why APIs are important
- What standards must be met
- The Victorian Government API Gateway and Developer.vic portal
- Contact the API team
- Related how-to guides
What’s an API?
An application programming interface (API) is an interface that enables safe and reliable software communication. It allows 2 pieces of software to work with each other even if they weren’t originally designed to interact.
When APIs are made available, software developers can use standardised tools to get data from a system, modify it as required, and use it somewhere else. APIs are often used to automate manual processes or to create new tools altogether.
APIs may be internal to a government agency, shared with trusted partners or out to the public.
What do we recommend?
The Victorian Government takes an API-first approach. This approach favours the use of APIs in most integration scenarios.
We recommend including an API with every Victorian Government online service, where possible.
The Enterprise Solutions WoVG Information Management Framework prefers APIs for making data integration easier and more streamlined.
APIs won’t always be the most appropriate integration style for all data. Victorian Government agencies should get in touch with apiteam@dpc.vic.gov.au to discuss the suitability of APIs to deliver on their business requirements.
Why APIs are important
APIs are a core part of many of the leading websites and mobile apps that Victorians use every day. They:
- enable software applications to make data discoverable to other applications and
- allow developers to use that data in new and innovative ways.
APIs help us to:
- Share data: Providing information and services through web APIs supports interoperability and openness. Well-designed APIs make data freely available for use within agencies, between agencies, in the private sector and by citizens.
- Increase reach: Reach more users by allowing other agencies, partners and the private sector to integrate – and amplify – your agency’s data, transactions and content.
- Save time: Use automation to update data or content once and your API can automatically refresh in multiple locations on a website, mobile platforms and social media platforms.
- Save money: Allow third-party innovators to create and share new, useful products and services beyond the scope – or budget – of your agency.
- Speed up product development: Allowing granular and open access to content improves prototyping and access for collaboration.
- Build markets: Assist entrepreneurs to develop products and services with access to government resources.
- Empower citizens: Open access enables external developers to build their own versions of online government services.
What standards must be met
The National API Design Standards (NAPIDS) aim to ensure consistency and standardisation when designing and building APIs to be used by agencies across the Whole of Victorian Government.
The NAPIDS are intended for API developers, solution architects and business analysts who are looking to design a new API or make changes to an existing service in order to improve aspects of usability, readability or security.
Compliance with the NAPIDS will ensure a consistent, streamlined experience for developers when accessing and using Victorian Government APIs.
The Victorian Government API Gateway and Developer.vic portal
We created the API Gateway and Developer.vic portal to provide a single access point to government APIs.
The API Gateway
The API Gateway allows Victorian government agencies and trusted third parties to securely share, re-use and enhance data in real-time. It allows API producers to:
- make their APIs discoverable to API consumers
- control who has access to their APIs
The API portal
The API portal, Developer.vic (part of the Department of Government Services), is the external-facing component for application developers.
It provides tools and resources for developers to:
- access the API Gateway
- integrate government data
- explore a growing catalogue of trusted government APIs
- see how APIs are being used across government
Support services
We also provide a range of end-to-end integration support services, including:
- API strategy development
- API design and build
- API hosting
Contact the API team
For more information or to get connected to the Gateway contact apiteam@dgs.vic.gov.au.
Related how-to guides
Publish an open data set - digital guide
This guide is a quick introduction to Victoria’s open data policy for government.
Secure your service - digital guide
An introduction to the Office of the Victorian Information Commissioner’s 5-step action plan and Protective Data Security Framework.
Updated 16 January 2025
Related links
Join the conversation on digital
Get advice and share your insights with other digital practitioners. Join the Single Digital Presence Community of Practice(opens in a new window).
About the VIC Government
- The Premier and ministers
- Find a Vic Gov department, agency or service
- Strategies and policies
- Inquiries and royal commissions
Grants and programs
Jobs and careers
Arts, culture and heritage
Business and the workplace
- Mentally Healthy Workplaces Framework
- Portable Long Service Authority
- Victoria’s racing industry
- Workforce Inspectorate Victoria
- Liquor licensing, sale and supply
Communities
- Children
- First Peoples - State Relations
- Finding records
- Gender equality & women’s leadership
- LGBTIQA+ equality
- Multicultural communities
- Seniors Online
- Veterans support and commemoration
- Volunteering in Victoria
- Youth Central
Education and training
- Victorian Early Childhood Regulatory Authority
- Early childhood education – information for professionals
- Kinder: Best Start, Best Life
- Education – information for parents
- Schools.Vic - information for schools
- Education grants, programs, awards and events
- PROTECT
- TAFE, training and universities sector
- TAFE Victoria
- Victorian Skills Authority
- Apprenticeships Victoria
- Learn Local
Environment, water and energy
Finance and economy
Health and social support
- Family violence reform
- NDIS Worker Screening Check
- NDIS and disability services and support in Victoria
- Patient Review Panel
- Transforming Trauma Victoria
Housing and property
Law and justice
- Adoption
- Births, deaths and marriages
- Honorary justices
- Machete ban
- Safeguarding Victorians against terrorism
- Stolen Generations Reparations Package
- Victims of Crime
- Victorian Racing Tribunal
Safety and emergencies
- Emergency Recovery Victoria
- Victorian Emergency Relief and Recovery Foundation
- Emergency Recovery Resource Portal
- How well do you know fire
- Fire Services Reform
- Water safety
- Marine Search and Rescue
Science and technology
- Data sharing and open data
- Data.vic - discover and access Vic Gov open data
- Developer.Vic - portal for API developers
- Go.vic URL shortener
- Vic Gov IT project dashboard
- Victoria’s free public wi-fi network
- Cyber security in the Victorian Government
Sport and recreation
Traffic and transport
- Cameras Save Lives
- Transport Fines
- Getting Around
- Transport Planning
- Transport Future
- Climate Change and transport
- Future Directions For Transport
- Transport projects
- Ports and Freight
Working in the Victorian Government
- Single Digital Presence home
- Accommodation and Library Services
- Executive employment in the Victorian public sector
- Budget, procurement and funding
- Careers in the Victorian Government
- Council and Regulator Toolkit
- Guidelines for working in government
- Join a government network
- Standards and guidelines
- VicFleet CarPool
- Victorian Government style guide