Hong Kong Observatory Integration Guide

This guide will walk you through integrating the Hong Kong Observatory API with your OpenAssistantGPT chatbot.

Overview

The Hong Kong Observatory provides comprehensive weather services for Hong Kong and the surrounding region. The service offers detailed weather forecasts, warnings, and climate information, including tropical cyclone tracking, rainfall distribution, and earthquake monitoring. It features specialized forecasts for aviation, marine activities, and public safety, along with historical climate data and scientific weather analysis. The API provides access to real-time weather data, radar imagery, and regional weather patterns specific to East Asia.

Integration Steps

1. Review API Documentation

First, visit the Hong Kong Observatory 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_hong_kong_observatory_data

Description: Get data using Hong Kong Observatory

URL: https://www.hko.gov.hk/en/abouthko/opendata_intro.htm

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_hong_kong_observatory_data action to your chatbot

Using the Integration

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

• Is there a tropical cyclone warning in Hong Kong?
• What's the rainfall distribution in Kowloon?
• Check the earthquake information for the region

The chatbot will automatically use the Hong Kong Observatory API to fetch and return the requested information.

Additional Resources

• Hong Kong Observatory API Documentation
• OpenAssistantGPT Actions Guide
• Custom Action Tutorial