NozbeのAPIについて調べてみた
2011 年 3 月 13 日
コメントはありません
最近、タスク管理ツールをRTMからNozbeに乗り換えました。
ちょっと高いのが難点ですが、見やすくて良い感じです。
せっかくなので、NozbeのAPIについて調べてみました。
ネタ元:Nozbe API
なんかネタ元のページを見ると、「ここには基本的なことしか書いてないから、ちゃんと使いたければ連絡しろ」みたいなことが書いてありますが、とりあえず無視。
次のようなURLにアクセスすると、JSON形式のレスポンスが返ってくるようです。
http://www.nozbe.com/api/method/param1-data1/param2-data2/key-apikey
メソッドだのパラメータだのはおいておくとして、すべてのアクセスにはAPIキーが必要となります。
これはユーザごとに固定で用意されているもので、各ユーザの設定ページで参照できます。
アプリでは、ユーザにAPIキーを設定してもらえばOK。
ユーザのメールアドレスとパスワードからAPIキーを取得する方法も用意されていまして、
http://www.nozbe.com/api/login/email-your@domain.com/password-test123
とすると、
{“key”:”1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6″}
のようにAPIキーが取得できます。
OAuthに対応していないのが残念です (´・ω・`)
メソッドの説明は長くなりそうなので、表にしました。
幅が足りなくて見づらいですが・・・。
| Method | Parameter | Response | |||
|---|---|---|---|---|---|
| Name | Summary | Key | Value | Key | Value |
| projects | プロジェクトリスト取得 | id | プロジェクトID | ||
| name | プロジェクト名 | ||||
| count | 未完了アクション数 | ||||
| contexts | コンテキストリスト取得 | id | コンテキストID | ||
| name | コンテキスト名 | ||||
| icon | アイコンファイル名 | ||||
| count | 未完了アクション数 | ||||
| actions | アクションリスト取得 | what | next: Next Actions project: プロジェクト指定 context: コンテキスト指定” |
id | アクションID |
| id | whatの値により以下を指定する。 next: 無視 project: プロジェクトID context: コンテキストID” |
name | アクション名 | ||
| showdone (optional) |
“1″ を設定すると完了アクションを取得できる。 whatがnext以外のときのみ有効。” |
name_show | HTML形式のアクション名(?) | ||
| done | “0: 未完了 1: 完了” |
||||
| done_time | “アクションが完了した日時 未完了時は “”0″”" |
||||
| time | アクションに必要な時間 | ||||
| project_id | プロジェクトID | ||||
| project_name | プロジェクト名 | ||||
| context_id | コンテキストID | ||||
| context_name | コンテキスト名 | ||||
| context_icon | コンテキストのアイコンファイル名 | ||||
| next | “next”: アクションがNext Action false: アクションがNext Actionではない |
||||
| notes | ノート取得 | what | project: プロジェクト指定 context: コンテキスト指定” |
id | ノートID |
| id | whatの値により以下の指定する。 project: プロジェクトID context: コンテキストID” |
name | ノート名 | ||
| body | ボディー | ||||
| body_show | HTML形式のボディー | ||||
| date | 作成日時 | ||||
| project_id | プロジェクトID | ||||
| project_name | プロジェクト名 | ||||
| context_id | コンテキストID | ||||
| context_name | コンテキスト名 | ||||
| context_icon | コンテキストのアイコンファイル名 | ||||
| check | アクション完了 | ids | アクションID “;” 区切りで複数指定可” |
response | “ok” |
| newaction | アクション作成 | name | アクション名 | response | アクションID |
| project_id | プロジェクトID | ||||
| context_id | コンテキストID | ||||
| time | アクションに必要な時間 | ||||
| next | trueを指定するとNext Actionとなる | ||||
| newnote | ノート作成 | name | ノート名 | response | ノートID |
| body | ボディー | ||||
| project_id | プロジェクトID | ||||
| context_id | コンテキストID | ||||
| newproject | プロジェクト作成 | name | プロジェクト名 | response | プロジェクトID |
| body | ボディー | ||||
| info | プロジェクト・コンテキスト詳細取得 | what | project: プロジェクト指定 context: コンテキスト指定 |
name | プロジェクト・コンテキスト名 |
| id | whatの値により以下の指定する。 project: プロジェクトID context: コンテキストID” |
body | ボディー | ||
| body_show | HTML形式のボディー | ||||