BC Ferries Integration Guide

This guide will walk you through integrating the BC Ferries API with your OpenAssistantGPT chatbot.

Overview

BC Ferries API provides real-time information about British Columbia's ferry services. The service offers sailing schedules, vessel capacities, and current conditions. It features route information, fare details, and service notices for the coastal ferry system.

Integration Steps

1. Review API Documentation

First, visit the BC Ferries API documentation to understand the available endpoints and how they work.

2. Create Custom Action

In your OpenAssistantGPT dashboard:

1. Go to the Actions Dashboard
2. Click "Create New Action"
3. Chose Get or Post
4. Fill the action form with the following details:

Name: get_bc_ferries_data

Description: Get data using BC Ferries

URL: https://www.bcferriesapi.ca/?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

1. Go to your Chatbot Dashboard
2. Select your chatbot
3. Go to "Settings" > "Actions"
4. Add the get_bc_ferries_data action to your chatbot

Using the Integration

Your chatbot can now handle transportation-related queries. Here are some example questions you can ask:

• Check next sailing to Vancouver Island
• Get current vessel capacity status
• Find ferry schedules for Tsawwassen

The chatbot will automatically use the BC Ferries API to fetch and return the requested information.

Additional Resources

• BC Ferries API Documentation
• OpenAssistantGPT Actions Guide
• Custom Action Tutorial