Introduction to the Lighthouse API

If you're ready to get your code on, there are some exciting possibilities with the Lighthouse API.

Everybody's needs are different, and you're no exception. That's why we've developed the Lighthouse API, to let you extend and integrate Lighthouse into other services. Let your imagination run wild!

What is the Lighthouse API?

The Lighthouse API is implemented as an XML REST interface. Typically, the client will make an HTTP request with XML data, and receive XML data in the response. There is a ruby library, though these examples can be performed with the curl command:

curl -H 'X-LighthouseToken: MYKEY' -d '...' http://url

In the context of this document, the term "Beacon" will be used to describe any application, service, or script that interacts with the Lighthouse API.

What can I do with the Lighthouse API?

There are many things that you can do with the Lighthouse API, here are a few examples of how we already use the Lighthouse API:

  • Posting Subversion Changesets and commit messages to the time line
  • Accepting and parsing incoming email messages to create and update tickets
  • Accessing and creating tickets through your Instant Messenger client.

Here are a few examples of things you could do with the API:

  • Create an OS X or Windows application for retrieving and creating projects, tickets, milestones and messages.
  • Integrate ticket updates and events with Google Calendar or other Calendar services.

Visit us in the forums

If you can't find what your looking for here, visit us in the forums.