Introduction
The API Reference is geared towards developers that would like to integrate Offbeat Guides order and processing functionality into their own application.
Architecture
The API utilizes a RESTful resource-oriented architecture that allows developers to use just about any programming language as long as it has the ability to make HTTP requests and parse XML and JSON-formatted data. This section covers the following topics:
- RESTful API Interface
The Offbeat Guides Reseller API utilizes a RESTful, purely HTTP based interface that allows you to create and manipulate orders within our system. Generally speaking, actions that retrieve data require a HTTP GET request, and actions that create, change, or destroy data require a HTTP POST request. These are the only HTTP/1.1 methods supported at this time, as DELETE, PUT, etc are not currently supported. See errors and warnings to review what HTTP/1.1 errors are implemented.
- Supported Response Formats
The Offbeat Guides API responds in the JSON data format.
- Parameter Requirements
Values must be converted to UTF-8 and URL encoded (as per GET and POST HTTP requirements).
Core Resources
Order Resource
The order resource allows you to retrieve, create, destroy, cancel, commit, validate and price an individual order.
Guide Resource
The guide resource allows you to create individual guides within a specified order and get its table of contents.
Section Resource
The section resource allows you to manipulate individual sections within guides, including creating new custom sections.
Geocode Resource
The geocode resource allows you to convert city names into the format used in guide destination and origin fields, or get a city name based on an IATA or WAC airport code.
Comments (0)
You don't have permission to comment on this page.