Flight Watchdog API
  • Introduction
  • Implementation
  • Example client
  • API Documentation
Powered by GitBook
On this page
  • Create a watcher
  • Schema
  • Request a detail
  • Manage customer limits
  • Delete a watcher
  • Schema
  • Receive a notification
  • Schema

Was this helpful?

Implementation

PreviousIntroductionNextExample client

Last updated 5 years ago

Was this helpful?

Create a watcher

To add a new price tracking, you need a watcher. The watcher is a database record containing information about a flight. Use it every time a customer wants to track a new flight.

Watcher contains:

  • Email - identifies the customer

  • Origin - city of departure

  • Destination - city of arrival

  • Departure - flight departure date

  • Arrival - flight return date

  • Price limit - price to be checked within search results

Schema

Request a detail

Manage customer limits

This function is not provided by the API. To simplify management of customer limits, the API provides a function that counts watchers for an email address.

API does not limit watchers for one email address.

For better detection of the customer duplicity, do not allow emails with the plus character.

Delete a watcher

The application must provide notification unsubscribing for every customer. This can be achieved by API function delete.

Schema

Receive a notification

If the API finds a lower price, it sends a notification. The URL of the notification is a part of the user settings.

After receiving a notification with a lower price, you can delete the watcher to reduce the number of watchers.

Schema