About     API     Contact
HowToDo
Start
About
API
Privacy policy
Open data
Contact

API documentation

We assume that most To-Do applications would like to integrate the functionality of HowToDo seamlessly and with only a thin layer of extra UI. Thus we provide a RESTful API to HowToDo that allows you to query our service in order to get a list of possible steps, encoded in JSON. This page describes the API and the answer format.

Method

There is only a single method, which has a small number of parameters. For now, all parameters but todo are optional.

Example: http://uri/howtodo/api.php?todo=driver's+license

Response format

The answer is encoded in JSON like in the following example. I hope it is self-explaining — if not, holler!

{
  "todo" : "driver's license",
  "id" : "q-22",
  "interpretations" : [
    {
      "interpretation" : "Get Your Driver's License",
      "rank" : "1",
      "id" : "wikihow-167966",
      "source" : "http://www.wikihow.com/Get-Your-Driver%27s-License",
      "attribution" : "wikiHow",
      "date" : "2010-08-31T02:16:21Z",
      "steps" : [
        {
          "text" : "Practice for the written test",
          "id" : "wikihow-167966-1",
          "fulltext" : "# '''Practice for the written test.''' \
            Get familiar with the basic driving rules and \
            regulations and learn important defensive \
            driving techniques by reading your State \
            Driver’s Handbook.",
        },
        {
          "text" : "Scheduling the Driver License test \
            appointment (Optional)",
          "id" : "wikihow-167966-2",
          "fulltext" : "#'''Scheduling the Driver License \
            test appointment (Optional).''' In order to \
            ...",
        },
        { ... },
        ...
      ],
    },
    {
      "interpretation" : "Get an Ontario Driver's License",
      "rank" : "2",
      "id" : "wikihow-581579",
      "source" : "http://www.wikihow.com/Get-an-Ontario-Driver%27s-License",
      "date" : "2010-03-24T14:38:54Z",
      "attribution" : "wikiHow",
      "steps" : [
        ...
      ],
    },
    {
      "interpretation" : "Pass Your Driving Test",
      ...
    },
    ...
  ],
  "more" : "true",
  "error" : ""
}

Caveat

Remember, this is a research prototype and we may change our API and our service without prior notice at any time. If you want some guarantueed service level, contact us.

Please be nice!
HowToDo is a research prototype, and we are building on top of other, free services. At any time, any of the involved services may decide to throttle, restrict, or close access.

Also, remember privacy and let your users know: we are saving all requested To-Dos for our evaluation. See our privacy policy for details.