arctic/arctic2api

API for interacting with Arctic Reservations version 2

Installs: 285

Dependents: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

0.7.1 2016-04-11 19:08 UTC

README

PHP and JavaScript based interfaces to the Arctic Reservations v2 API.

PHP

These classes make it easy to access data from Arctic Reservations and make changes, all via a PHP object oriented interface. The files include support for OAuth 2.0 authentication, as well as access to the REST API to browse, create (insert), read (load), update and delete objects.

Initial classes are provided for common API endpoints, comments provide documentation on common fields (although fields may vary based on system configuration) and examples show basic usage.

To use these functions, you must have both client credentials and API credentials. If you are an Arctic Reservations customer, please contact support for this information.

Support for:

  • Persons
  • Person metadata - addresses, phone numbers, email addresses, notes
  • Inquiries
  • Invoices
  • Invoice data - groups, items, transactions
  • Activities
  • Reservations
  • Reservation members (guests)
  • Trips
  • Trip types
  • Trip pricing levels
  • Trip add-ons
  • Rentals
  • Rental includes
  • Rental items
  • Rental item pricing levels
  • Business groups

Requires PHP 5.3+ (supports PHP 7.0).

JavaScript

The JavaScript reservation widget makes it easy to build custom replacements to the first step of the online booking process, including the ability to search and filter trips, as well as to display the initial booking form to get guest and add-on information. The JavaScript functionality relies on an open (unauthenticated) API for online reservations.

Version

Version v0.7 (beta)

The API is approaching a version 1 release. Version 0.6 introduces the JavaScript reservation widget, as well as a few example implementations.

The repository has also been renamed to remove PHP from the name.

Version 0.7 has added a few new models (activities, rentals and reservations), added more methods to existing models (such as price and availability data for rental items) and substantially improved error handling by providing different exception types based on the HTTP status code.

Authors

L. Nathan Perkins