Integrate Auckland Transport API with Your NZ Transit Assistant
Learn how to integrate Auckland Transport API with your AI agent for New Zealand transit information.
Transport for Auckland, New Zealand Integration Guide
This guide will walk you through integrating the Transport for Auckland, New Zealand API with your OpenAssistantGPT chatbot.
Overview
Auckland Transport's API provides comprehensive information about public transportation in Auckland. The service offers real-time vehicle tracking, schedule updates, and service alerts. It features journey planning, fare information, and station details for Auckland's transit network.
Integration Steps
1. Review API Documentation
First, visit the Transport for Auckland, New Zealand API documentation to understand the available endpoints and how they work.
2. Create Custom Action
In your OpenAssistantGPT dashboard:
- Go to the Actions Dashboard
- Click "Create New Action"
- Chose Get or Post
- Fill the action form with the following details:
Name: get_transport_for_auckland_new_zealand_data
Description: Get data using Transport for Auckland, New Zealand
URL: https://dev-portal.at.govt.nz/?ref=public_apis&utm_medium=website
Parameters: This will depend on the API you are integrating. Parameters are query parameters passed in the URL.
3. Assign Action to Your Chatbot
- Go to your Chatbot Dashboard
- Select your chatbot
- Go to "Settings" > "Actions"
- Add the get_transport_for_auckland_new_zealand_data action to your chatbot
Using the Integration
Your chatbot can now handle transportation-related queries. Here are some example questions you can ask:
- Find next bus to CBD
- Check train times to Britomart
- Get ferry schedule to Devonport
The chatbot will automatically use the Transport for Auckland, New Zealand API to fetch and return the requested information.