アカウントログイン





パスワードをお忘れですか? ちょうど こちらをクリック

安全のために、HTTPS(SSL)接続を使用してログインします。

パスワードをお忘れですか?



WebサービスとしてのNozbe

高度なAPIを使ってNozbeと会話する偉大なアプリケーション製品を作ってください。


This page contains only a basic reference of the NOZBE API and it should be used for testing initial communication with Nozbe and initial ideas how to work with Nozbe and your apps. We have since evolved and have a great, fast and secure SYNC-API that we use to sync with our iPad and iPhone apps and that we'll be happy to give you access to, if you have a cool idea how to build upon it and create some cool Nozbe widgets and integrations.

If, after playing with this basic API you need an access to the full NOZBE SYNC-API to make your project work with Nozbe in a very cool way, just contact us and tell us about your project.

Welcome to the world of web services!

Nozbe API gives a great possibility for your applications to talk to Nozbe... or even better - you can create your own applications based on Nozbe. Nozbe API is a work-in-progress, meaning we'll be adding more and more functinality to Nozbe with time.

This web site will explain how Nozbe API works - it's meant for developers who have experience in PHP/JavaScript.

How it works

Nozbe API is very simple to use, all the requests are based on one easy Nozbe link:

https://webapp.nozbe.com/api/

So if you want to call a method with two parameters and an API key:

https://webapp.nozbe.com/api/method/param1-data1/param2-data2/key-apikey

The response is sent to you in JSON formatted string.

Authentication

As I've mentioned before, in order to use the Nozbe API user must be authenticated using the API-key (in your Nozbe Account/Extras). API-key is unique for each and every user so you must not give away your API-key. It would be like giving away your email and password.

Alternatively, you can obtain the API key by providing your Nozbe user's email and password.

https://webapp.nozbe.com/api/login/email-your@domain.com/password-test123

If the user name and password are correct, you will receive a JSON response:

{"key":"1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6"}

Projects

To get a list of projects, just call method projects:

https://webapp.nozbe.com/api/projects/key-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6

If everything is ok, you'll receive a JSON response, for example:

[{"id":"c4ca1","name":"Inbox","count":"4"}]

id - unique id of your project
name - name of the project
count - number of unfinished actions in the project

Contexts

To list users's contexts, just call method contexts:

https://webapp.nozbe.com/api/contexts/key-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6

If everything is ok, you'll receive a JSON response, for example:

[{"id":"c4ca1","name":"No context","icon":"icon-task.png","count":"20"}, {"id":"c81e2","name":"Errand","icon":"icon-errand.png","count":"7"}]

id - unique id of your project
name - name of the project
icon - icon file name representing this context
count - number of unfinished actions in the context

Actions

To list actions from users' "next actions" list, project or context, just call the method actions with additional parameters:
what - list to use, values are:
- next for next actions
- project for a specific project
- context for a specific context
id - unique id of "project" or "context" (if what="next", the "id" will be ignored)
showdone - (optional parameter) set as "1" if you want to list the completed actions (works only if what is set as "project" or "context")

Examples:

https://webapp.nozbe.com/api/actions/what-next/key-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6
https://webapp.nozbe.com/api/actions/what-project/id-c4ca1/key-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6
https://webapp.nozbe.com/api/actions/what-context/id-c4ca1/key-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6 https://webapp.nozbe.com/api/actions/what-project/id-c4ca1/showdone-1/key-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6

Example JSON response:

[{"id":"1234","name":"Simple task","name_show":"\tSimple task", "done":0,"time":"30","project_id":"c4ca1", "project_name":"Inbox","context_id":"c4ca1", "context_name":"No context","context_icon":"icon-task.png","next":false}]

In the above example the result is one action with the following parameters:
- id - unique id of the action
- name - source name of the action
- name_show - HTML-parsed name of the action (Textile applied)
- done - 0 = uncompleted / 1 = completed action
- done_time - date and time when the action has been completed "YYYY-MM-DD HH:MM:SS", "0" if uncompleted
- time - time (in minutes) that will take to finish the action
- project_id - unique id of the action's project
- project_name - action's project name
- context_id - unique id of the action's context
- context_name - action's context name
- context_icon - icon file name representing this action's context
- next - "next" = if this action is "next action", otherwise false

Notes

The list of notes connected with project/context can be generated in a similar way as actions. Examples:

https://webapp.nozbe.com/api/notes/what-project/id-c4ca1/key-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6
https://webapp.nozbe.com/api/notes/what-context/id-c4ca1/key-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6

Example JSON response:

[{"id":"1234","name":"Test note","body":"Notes are great!","body_show":"\t<p>Notes are great!</p>", "date":"29 Jan 07","project_id":"c4ca1","project_name":"", "context_id":"c81e2","context_name":"Errand","context_icon":"icon-errand.png"}]

In the above example the result is one note with the following parameters:
- id - unique id of the note
- name - name of the note
- body - source body of the note
- body_show - HTML-parsed body of the note (Textile applied)
- date - date when the note has been created
- project_id - unique id of the action's project
- project_name - action's project name
- context_id - unique id of the action's context
- context_name - action's context name
- context_icon - icon file name representing this action's context

Check (mark actions as "completed")

You can mark one or several actions at once as completed by using the check method and listing IDs of the actions separated with semicolon ";" as the ids parameter. Example:

https://webapp.nozbe.com/api/check/ids-c4ca1;324123/key-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6

After it's been done, you'll receive a JSON encoded response "ok".

Create New Action / New Note / New Project

No POST, just call the same nice API url with newaction, newnote or newproject method respectively and some parameters like:

- name - action/project/note name (url-encoded)
- body - project/note body (url-encoded)
- project_id - id of the project
- context_id - id of the context
- time - time in minutes (action only, values: 5,15,30,60,90,120,180...)
- next - if sent, action will be added to "next actions" list

Examples:

https://webapp.nozbe.com/api/newaction/name-test/project_id-c4ca1/context_id-c4ca1/time-60/next-true/key-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6
https://webapp.nozbe.com/api/newnote/name-test/body-test/project_id-c4ca1/context_id-c4ca1/key-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6

If successfully added, you'll receive a JSON response with item's ID:

{"response":"1234"}

Project / Context info

To get more details about a specific project (name, body) or context (name, body, icon), we've created a method called info that has to be called with additional parameters:
- what - yes, you guessed it, values are: "project" or "context"
- id - unique id of the item we want to know about.

Example:

https://webapp.nozbe.com/api/info/what-project/id-c4ca1/key-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6

This will result in a JSON response:

{"name":"Nozbe","body":"Test *body*","body_show":"\t<p>Test <strong>body</strong></p>"}

In the above example the result is one note with the following parameters:
- name - name of the project/context
- body - source body of the project/context
- body_show - HTML-parsed body (Textile applied)