Diff for "API"

Not logged in - Log In / Register

Differences between revisions 28 and 29
Revision 28 as of 2010-03-12 22:01:06
Size: 2027
Editor: pool-173-73-119-120
Comment:
Revision 29 as of 2010-03-13 00:02:59
Size: 2103
Editor: 78-105-1-164
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
Line 10: Line 9:
 * Most users will be happy with [[API/launchpadlib| launchpadlib]], the official Python client library for Launchpad's web service.  * Most users will be happy with [[API/launchpadlib|launchpadlib]], the official Python client library for Launchpad's web service.
Line 28: Line 27:
 * See our directory of [[API/Uses|code that uses the Launchpad APIs]] for examples.  * See our directory of [[Clients|clients]] and [[API/Uses|code that uses the Launchpad APIs]] for examples. Also, we have a page of [[API/Examples|example code]].

Launchpad web services API

Note: This page discusses the Launchpad web service API from the perspective of a Launchpad user. If you want to help develop the API, see the Launchpad dev wiki instead.

The Launchpad website lets you learn about and manage bugs, projects, questions, and other artifacts of software development. These same objects are gradually being exposed through a web service, so that you can access them from scripts, applications, or other websites, in addition to accessing them through the Launchpad website. The service is designed around the principles of REST, with the goals of simplicity and transparency.

The Launchpad web service is currently in a limited beta, open to Launchpad's beta testers.

  • Most users will be happy with launchpadlib, the official Python client library for Launchpad's web service.

   >>> me = launchpad.me
   >>> me.display_name = 'My new display name'
   >>> me.lp_save()
  • Users who aren't Python programmers, or who are interested in the inner workings of the web service, should read the hacking document.

   PATCH /beta/+me HTTP/1.1
   Host: api.edge.launchpad.net
   Content-type: application/json

   { "display_name" : "My new display name" }
  • See our directory of clients and code that uses the Launchpad APIs for examples. Also, we have a page of example code.

  • If you're writing your own interface to Launchpad, instead of using launchpadlib, you'll need to know how OAuth works. Signing Requests explains how to walk your end-users through the process of getting a set of OAuth credentials that you can use to make Launchpad web service requests on their behalf.

  • Everyone can appreciate the reference documentation.

  • When will the limited beta become an open beta? When will the open beta become a full release? The roadmap has the answers.

API (last edited 2023-07-06 08:24:58 by ines-almeida)