Introduction

The orderTopia API provides a simple RESTful interface with lightweight JSON-formatted responses to use many of orderTopia's web services. Accessible items include passing data on public profiles, merchants, menus, favorites and social networking services.  This document provides information to developers on how to integrate with the orderTopia API.

Concepts

Authentication

The orderTopia API requires a developer API key which can be provided any time after registration.  The key identifies you as a unique entity making calls against the orderTopia web service, and is used to track overall call usage. Presently, all available API methods access only public information.

HTTP Requests

The orderTopia API uses RESTful URIs and standard HTTP GET and POST requests to provide information to developers. Any web programming language (PHP, Ruby, Python, Java...) should be able to make and receive HTTP networking calls; consult the documentation for your language of choice.

Rate Limiting

Clients are allowed approximately 2,000 requests per 24-hour period, in addition to rate limits on queries per second. If your application needs more than the allotted amount of calls, contact us at This e-mail address is being protected from spambots. You need JavaScript enabled to view it with a description of the application and an estimate on call usage. You may also want to investigate the use of caching to keep the number of calls to a minimum, and make your application more responsive.

Access Restrictions

Some API calls are considered privileged and are restricted to certain classes of developers. Consult the documentation for more details.