約 1,017,957 件
https://w.atwiki.jp/nicoapi/pages/15.html
このページに関して API のテンプレートを記述します。この書式に従って記述してください。 [Web API] API 名 APIの説明、概要。 リクエスト URL GET/POST または GET、POST http //～。変数は { } でくくる。 ex) GET http //ext.nicovideo.jp/api/getthumbinfo/{video_id} video_id ビデオ ID データ形式 正常な場合のデータ形式を解説する。詳細解説はなくてもいいかも。わかりにくいところだけピックアップするのもよし。 ex) XML 形式。 nicovideo_thumb_responsestatusthumbvideo_id ID title 題名 tags タグ一覧domain 言語tag タグcategory [省略可] カテゴリー ロックあれているかlock [省略可] タグ ロックされているか user_id ユーザー投稿動画のみ存在する。ユーザー ID データサンプル データサンプルに関する状態 データサンプルを記述する。成功例、失敗例ともに記述すること。また行数は必要な場合のみ表示すればよい (linenumber 指定) (ex) 正常な場合 root parent child attribute="yes!" / /parent /root (ex) 不正な場合 JSON は http //www.ctrlshift.net/jsonprettyprinter/ で整形するとよい。 { "parent" { "child" { "attribute" "yes!" } }} 関連API 関連した項目を列挙。たとえばデータ構造が同じなど。 ex) -ページリンク (補足説明) 更新履歴 変更があった場合、変更を記述するほうが好ましい…? ex) 2014/2/6 記述
https://w.atwiki.jp/nicoapi/pages/25.html
iOS API 一覧 ほとんどが HTML で受信する API の数々。UA が iOS になってないとロードできない。ぶっちゃけ、あまり使い物になるとは言えない。 全 API に対して Host は i.nicovideo.jp ログイン系 API /v6/login v よくわからない。デフォは 6%2E20 XML で返答。
https://w.atwiki.jp/nicoapi/pages/24.html
Vita API Vita API とはその名前の通り PS Vita から発展していった API です。ほかの Wii U や 3DS でも利用されており、PC 向けの Windows ストア アプリの niconico (以後この記事では WSA とします) でも一部に Vita API が使われています。 REST API としてバージョン管理されており、現在のバージョンは v1 になっています。将来的に OAuth でのアクセスも考えられるので、今から実装しておいて問題はないでしょう。 全 API に対して Host は api.ce.nicovideo.jp GET または POST、どちらでも可 __format で json か xml を指定できる __context (前回の状態?) とかも発行しているっぽい (3DS)。WSA はつけてない代わりにキャッシュを働かせないために dummy=[unixtime] としている。 セッション系 API /api/v1/session.create これで受け取った session_key を x-nicovita-session としてヘッダーに付与 [セッション要] /api/v1/session.alive ユーザー関連 /api/v1/user.info user_id [セッション要] /api/v1/user.premium /nicoapi/v1/user.myvideo from limit order/sort ※1 user_id 動画系 API /nicoapi/v1/video.info v 動画 ID /nicoapi/v1/video.array v 複数の動画 ID (カンマ区切り) [セッション要] /nicoapi/v1/video.play v [?] /nicoapi/v1/video.playlen start end よくわからない。Wii U で使われいた。詳細不明。 /nicoapi/v1/video.relation v 動画 ID from to order/sort ※1 /nicoapi/v1/video.ranking genre ※2 span ※3 type ※4 /nicoapi/v1/video.sherlock cmd recommend? limit /nicoapi/v1/video.ceselected from limit list_id [option] mode topic または vocaloid /nicoapi/v1/wiiu.ranking genre ※2 /nicoapi/v1/wiiu.trendytag genre ※2 /api/v1/achieve.set cat title となっていた。 date 20140418%2c20140331 のようになっていた。範囲版 date (?) マイリスト関連 /nicoapi/v1/mylistgroup.get detail 0 or 1 group_id マイリストの ID /nicoapi/v1/deflist.list from limit [セッション要] /nicoapi/v1/deflist.add description v /nicoapi/v1/mylist.list from limit group_id order/sort ※1 [セッション要] /nicoapi/v1/mylist.add description group_id v /nicoapi/v1/mylist.search from limit order sort str チャンネル動画関連 /nicoapi/v1/video.channelrecentvideo category_id /nicoapi/v1/video.channelselected from limit 動画検索関連 /nicoapi/v1/video.search str キーワード from limit order/sort ※1 /nicoapi/v1/tag.search tag タグ from limit order/sort ※1 生放送関連 video, community は全共通データ構造。 /liveapi/v1/video.info →V1-video.info /liveapi/v1/video.array →V1-video.array [セッション要] /liveapi/v1/video.play v /liveapi/v1/video.onairlist →V1-video.onairlist /liveapi/v1/video.comingsoon →V1-video.comingsoon /liveapi/v1/video.search.solr →V1-video.search.solr [セッション要] /liveapi/v1/user.subscribe from limit スレマ関連 スレマに関しては動画とコミュニティーの両方が存在する。X には video または community を指定する。 /api/v1/step.X.ranking date ※5 from limit type ※4 /api/v1/step.X.aroundranking content_id date ※5 range /api/v1/step.X.reporter id [セッション要] /api/v1/step.reportable sp_enabled ステップ数報告可能か (?) total_sp_count 合計ステップ数表示の有無 (?) 普通一般常識があるなら、この API には関与しないほうがよい。アプリ製作者の倫理問題だ (忠告)。 コミュニティー関連 [セッション要] /api/v1/community.info id [セッション要] /api/v1/community.array id [セッション要] /api/v1/comunity.list type ch など * カテゴリー関連 /nicoapi/v1/genre.list (※2) group 1 を付けるとグループ カテゴリー読み込み all (全部) のみこの API から取得できない その他 /api/v1/system.unixtime UnixTime を得るだけの API /api/v1/blog.info type wiiu/3ds/vita など ※ 1 order d 昇順 a 降順 sort t マイリスト登録 a タイトル c マイリストコメント f 投稿 v 再生 n コメント (日時) r コメント (量) m マイリスト l 動画の長さ 3 span daily 24 時間 hourly 毎時 weekly 週間 monthly 月間 total 合計 4 type fav 総合 view 再生 res コメント mylist マイリスト 5 date YYYY-MM-DD
https://w.atwiki.jp/nicoapi/pages/26.html
AndroidOS API 一覧 Vita API と全く違う。Scala で書かれている API であろう。ゆえに別記事として扱う。 なお、AndroidOS API は API で完結しているわけではなく、別途 HTML も読み込んだりしているので、扱いとしては Vita API より一つ下と考えてよいだろう。 全 API に対して Host は api.gadget.nicovideo.jp 動画関連 [セッション要] /video/videos/{video_id} video_id 動画ID /video/videos/by_ranking pageSize category all など max order fav など page span hourly など /video/videos/by_keyword pageSize page sortKeyTypeCode v/f/m/n など sortOrderTypeCode d/a keyword /video/videos/by_tag pageSize page sortKeyTypeCode sortOrderTypeCode tag /video/videos/sm～/play 生放送関連 /live/lives/by_ranking pageSize providerTypeCode community/official_and_channel など page liveStatusTypeCode onair/comingsoon など category max order span hourly など /live/lives/by_ranking/closed pageSize providerTypeCode page selectDate YYYY-MM-DD /live/lives/by_reserved pageSize page isForwardChannelSort useFilter /live/lives/by_keyword pageSize page liveStatusTypeCode sortOrderTypeCode point など keyword /live/lives/by_tag pageSize page liveStatusTypeCode sortOrderTypeCode tag /live/lives/lv～/play /live/tags/by_recommended count ユーザー関連 /user/profiles/～ [セッション要] /user/profiles/{user_id}/nickname user_id ユーザーID [セッション要] /user/mylists/{mylist_id} mylist_id マイリストID インフォ関連 /niconicoinfo 詳細不明 /sp/organizations /info pageSize page
https://w.atwiki.jp/api_programming/pages/63.html
下位ページ Context Folders Task Content 認証かたデータの取得・編集まで 流れ 1.遷移scopeの種類 2.Toodledoのサイトでアプリを承認 3.リダイレクトとパラメータパラメータ トークンの取得パラメータ レスポンス リフレッシュトークンパラメータ エラーコードサンプル Developer's API Documentation Version 3.0 - Toodledo 認証かたデータの取得・編集まで https //api.toodledo.com/3/account/index.php 流れ Toodledoの認証ページに遷移 ユーザーが、Toodledoアカウントにサインインして、アプリを承認 認証コードと共にアプリケーションにリダイレクト アプリケーションの秘密鍵を使って、トークン（とリフレッシュトークン）を取得トークンをアプリに保管し、これを使ってAPIリスエストを実行する。 トークンが失効したら、リフレッシュトークンを使って新しいトークンを取得する。 リフレッシュトークンも失効したら、最初の認証からやり直し。 1.遷移 ベースURL https //api.toodledo.com/3/account/authorize.php? response_type=code（決め打ち） client_id 登録したID client_id=YourClientID state クロスリスエストでの偽装を防ぐための（毎回）ランダムなコード state=YourState scope アクセスできる情報の範囲 例：scope=basic%20tasks ※半角スペースは%20 https //api.toodledo.com/3/account/authorize.php?response_type=code client_id=YourClientID state=YourState scope=basic%20tasks scopeの種類 basic - アカウント情報 tasks - タスク notes - ノート outlines - アウトライン lists - リスト share - 共同作業者の情報 write - 上記の情報の編集を許すかどうか 2.Toodledoのサイトでアプリを承認 Toodledoのユーザが、アプリケーションによるToodledoデータの操作を承認したら、（Toodledo上で登録した）リダイレクトURLへ遷移される。このとき、URIとしては、以下の情報が与えられる。 code 次のステップでアクセストークンを手に入れるためのコード state 承認のリクエストが来た際のstate情報。cross site request forgery を避けるために使用する。 error 何かしらのエラー（ユーザーが要求を棄却したとか）がある場合はここに記録される。 REDIRECT_URI?code=49075c51ed30133f909f7c0dd03996e8f395be57 state=YourState Javaなら、HttpServletRequest requestで request.getParameter("hoge") で取得 Java/JSP リダイレクトのあ使い方には２種類ある。 プロジェクトにカスタムURLをセットして、処理させるこれは、デバイスに "myToodledoApp //authorize" のような支持を出して、アプリケーションを起動させるような使い方。You would redirect the user to the device s built in web browser and the web browser will automatically launch your app with the authorization code in your apps launch options. カスタムWEBヴューをつくるThe second option is to keep the user in your app by implementing a custom web view (like an iframe) that contains our authorization page. You can then override the redirect method and grab the returned URL without actually fetching it. In this case the redirect URI would never be called, so it doesn t need to be an actual valid URI, although for obvious security reasons you should not have the Redirect URI go to valid URL not controlled by you. There are OAuth2 libraries for iOS, Android and other platforms that can help with this and we have provided some sample code as well. 3.リダイレクトとパラメータ パラメータとともに元ページにリダイレクトされてくる。 リダイレクト先はToodledoに登録しておく。 どこのサイトを書いても、後に code=aaaa state=bbbbのようについて来る パラメータ code アルファベットの文字列のコード。次のステップでアクセスするトークンを取得するのに用いる state 認証リクエストにともに送った state。cross site request forgery を避けるために、自分で送った state を比較し確認する。 error 認証リクエストが拒否されたりエラーを起こした場合に、この文字列が表示される。 連携元がウェブサイトではない場合 Monacaでつくるアプリの場合 トークンの取得 認証コードの取得後、トークンとの交換を行う。 SSLで暗号化されたリクエストを クライアントIDと秘密鍵と認証コードを使って/3/account/token.php にポスト(POST)する。 そのレスポンスはアクセストークンとリフレッシュトークンを含んでいる。 トークンのリクエスト時に、アプリケーションの幾つかの情報を送ることもできる。 それらは分析ページで見ることができる。つまり、どんなデバイスが使われるかなどの分析ができる。 POST先 https //api.toodledo.com/3/account/token.php クライアントIDと秘密鍵はそれぞれ、client_id、client_secret、として、下記のパラメータと同じようにしても渡せる。 Javaでのプログラミング パラメータ grant_type "authorization_code"という文字列.（必須） code 認証コード（必須） vers アプリケーションのバージョン。整数値。（任意） device アプリケーションが動作しているデバイス／プラットフォーム（任意） os アプリケーションが走っているOSのバージョン。整数値。（任意） f レスポンスのフォーマット。json か xml。デフォルトはjson（任意） レスポンス JSONで、キーと値の組で戻ってくる access_token アルファベット文字列 expires_in アクセストークンの有効期限。7200秒の固定（のはず） token_type なに？Bearer scope スコープ。スペース区切りの文字列 refresh_token アルファベット文字列 リフレッシュトークン access_tokenが時間切れで失効した場合には、refresh_tokenを使って新しいaccess_tokenを取ってくる。 refresh_tokenの有効期限は30日。これが切れたら認証し直し。 POST先は通常のToken取得と同じhttps //api.toodledo.com/3/account/token.php basic認証も必要 パラメータ grant_type "refresh_token"という文字列.（必須） refresh_token refresh_token（必須） vers アプリケーションのバージョン。整数値。（任意） device アプリケーションが動作しているデバイス／プラットフォーム（任意） os アプリケーションが走っているOSのバージョン。整数値。（任意） f レスポンスのフォーマット。json か xml。デフォルトはjson（任意） エラーコード token API endpointから受け取るエラーコード（メッセージ） Here is a list of the error messages that you may receive from the token API endpoint. 101 SSLで接続していない 102 There was an error requesting a token. 103 トークンのリクエスト数が上限を超えた サンプル JSON {"errorCode" 101,"errorDesc" "SSL connection required"} XML error id="101" SSL connection required /error
https://w.atwiki.jp/nacho/pages/36.html
API APIは廃止になり現在(2019年）はESIというシステムに代わっています。 APIキー作成手順 EVE Community ①上記URLの画面上部にある【SUPPORT】の上にマウスカーソルを移動させる。 ②【API KEY MANEGIMENT】をクリックする。 ③上記画面にてAPIを作成したいアカウントの【ID】と【PASS】を入力する。 ④画面右上にある【CREATE NEW API KEY】をクリックする。 ⑤作成するAPIキーの名前を入力する。 ⑥有効期限(Expirys)を設定する。 ※特に期限が必要なければ、有効期限無し(No Expiry)に設定すること。 ⑦必要なAPI項目をクリックして追加する。 ⑧画面右下の【SUBMIT】をクリックして決定する。 ⑨上記画面の【Key ID】と【Code】を控えて使用するツールへ登録する。 ※このAPIキーは説明のために作成したため、既に削除済み！ 以上でAPIキー作成手順の説明を終わります。
https://w.atwiki.jp/api_programming/pages/72.html
下位ページ Saved Search タスクの削除 タスクの取得 タスクの編集 タスクの追加 情報フィールド Content Task（タスク）のデータフィールド Adding Tasks Deleting Tasks Error Codes Task（タスク）のデータフィールド retrieve, setに共通して用いられるフィールド GT AD ED DN DD SR フィールド 定義 フォーマット、制限 △ ◯ added タスクが追加された日。UNIX時間で表記。 タスクが追加された「時間」は記録されない。常に正午としてカウントされる。 △ ◯ addedby タスクを割り当てたユーザのId (※subscriptionユーザ限定). ◯ × after この時間以降に更新したタスクを探索 UNIX時間。 △ ◯ attachment 添付アイテムの配列。各アイテムは３つのフィールドを含む。添付アイテムは読み取り専用。アウトラインを参照するidを使えます。リスト(list)、ノート(note)はこのAPIを通して取得可。ファイルは現在読めないが、機能追加準備中。 ○ - - - - × before この時間以前に更新したタスクを探索 UNIX時間。 × ◯ checked Whether the task is completed or not △ ◯ children このタスクが持つサブタスク数 サブタスク自身や、サブタスクを持たないタスクは0 ◯ comp 未完了、完了の選択。 0 未完のみ、1 完了のみ、無しor-1 両方 × ◯ ◯ completed いつタスクが完了したか 未完了の場合、0.UNIX時間。Toodledoはタスクが完了した「時間」はトラッキングしない。そのため、タスクは正午に完了、として処理される。 △ ◯ ◯ context コンテクストのID番号 コンテクスト割当なしの場合は省略（もしくは0） △ ◯ ◯ duedate タスクの期限（日） UNIXタイムスタンプ（GMTの正午）タイムスタンプ＝1445172465↓日時（Tokyo）＝2015/10/18 21 47 45 △ ◯ ◯ duedatemod 期限（日）のタイプを示す整数 0 Due By1 Due On (=)2 Due After ( )3 Optionally (?) △ ◯ ◯ duetime for when the task is due. UNIX時間。設定しなければ0.duedateが設定されず、duetimeのみが設定されていると、1970年1月1日と判断。タイムゾーンにかかわらず、10amは10amと判断。You can convert this timestamp to a GMT string and display the time component without worrying about timezones. ◯ duration ○ fields レスポンスに付けて返してほしいフィールド コンマ区切り。レスポンス向上のため、不用なら省略する。 △ ◯ ◯ folder フォルダのID番号 フォルダ割当なしの場合は0もしくは省略。 △ ◯ ◯ goal goalのID番号 goal割当なしの場合は省略（もしくは0） △ - ● - - × id タスクID アカウントに対してユニークな番号（違うアカウントに対しては、同一のIDに対して異なるタスクがぶら下がる可能性あり。 △ ◯ length タスク達成までの予想時間（分、整数値） △ ◯ ◯ location 場所のID番号 割当なしの場合は省略（もしくは0） △ ◯ meta A text for storing metadata about the task. This is useful for syncing data that cannot otherwise be synced to Toodledo. Because of an implementation detail, using the meta field introduces extra latency to each API call, so you should only use this field when necessary. 1,024バイトまで。タスクごとにユニークなIDを持ち、AppIDに対してprivate。ユーザーもAppIDsも個々に入力した値は見られない。 - ◯ modified for when the task was last modified. UNIX時間。 △ ◯ note ノート 32,000 bytesまで。改行コードは\n ◯ num 取得するタスク数。複数ページで表示する場合などに使用 デフォルト値、最大値ともに1000 △ × order サブタスクの順番 読み取り専用 △ ◯ parent 親タスクのID番号 デフォルト値はO △ × previous If the task was repeated from another task, this will contain the id number of the previous version of this task. △ ◯ ◯ priority 優先順位。整数値。 3 = Top2 = High,1 = Medium,0 = Low,-1 = Negative, △ ◯ ◯ remind リマインダが送られる、タスクの期限までの時間（分）を表す整数値。 0 リマインダなし値の制限：0, 1, 15, 30, 45, 60, 90, 120, 180, 240, 1440, 2880, 4320, 5760, 7200, 8640, 10080, 20160, 43200)。これ以外は近い値に丸め。無料ユーザーは0か60。 △ ◯ ◯ repeat どのようにタスクを繰り返すかを示す文字列 記録を残すため、リピートするタスクが完了した場合ははコピーされたタスクがリストに加えられ、完了タスクに対して、新しいID番号が付与される。繰り返しを中止するには、これに空文字列を設定。記法は※を参照。 △ ◯ shared that indicates if the task is shared as a joint task (Subscription required for user). A boolean (0 or 1) 。読み取り専用 - × sharedowner The user id of the person who owns the task that is being shared with the current user. If the current user is not the owner, then they cannot make changes to the collaboration settings for this task, although they can make other changes. 読み取り専用 - × sharedwith An array of user ids for people that this task is shared with, other than myself and the owner. Read only. △ ◯ ◯ star スターの有無 0 スターあり1 スターなし ◯ start スキップするタスク数。複数ページで表示する場合などに使用 デフォルト値は0 △ ◯ ◯ startdate タスクの開始（日） A GMT unix timestamp △ ◯ ◯ starttime for when the task starts. UNIX時間。 △ ◯ ◯ status タスクのステータスを表す整数値 0 = None, 1 = Next Action,2 = Active, 3 = Planning,4 = Delegated, 5 = Waiting,6 = Hold, 7 = Postponed,8 = Someday, 9 = Canceled,10 = Reference × ◯ subtask △ ◯ ◯ tag タグ 複数の場合はコンマで区切る。64文字まで。 △ ● ◯ - - ◯ title タスクタイトル 文字列。255文字まで。 △ ◯ timer The value in the timer field indicates the number of seconds that have elapsed for the timer not including the current session. × ☓ timeron （タイマーON時）タイマースタート時間のタイムスタンプ Total Time=timer+(now-timeron). Where "now" is a unix timestamp for the current time. △ ◯ via A read-only field that indicates how the task was added. 読み取り専用-0 Main website-1 Email Import,-2 Firefox Addon-3 This API,-4 Widgets (Google Gadget, etc)-5 Not used,-6 Mobile Phone-7 iPhone App,-8 Import Tools-9 Twitter ※繰り返し(repeat)を表現する文字列は、iCal RRULEフォーマットに従う。 "FREQ=DAILY" "FREQ=WEEKLY;BYDAY=TU" 但し、Toodledoで全てのiCal RRULEが解釈されるわけではない（鋭意対応中）。ので、ToodledoのFAQを参照のこと。ユーザーがGUIや人間が理解できる文字列（英語）で記入する。iCalのルールに変換される。 There are three enhancements to the iCal RRULE format that we have made to support some advanced Toodledo features. Subtasks can repeat based on their parent s repeat value. There is not a comparable iCal RRULE for this, so we have a custom RRULE of "PARENT" to indicate this setting. Tasks can be set to repeat from their due-date or their completion date. There is not a way to indicate this in a standard iCAL RRULE. To indicate this, we have a custom string of ";FROMCOMP" that we append to the RRULE if the task is set to repeat from the completion date. The absence of this string means that the task repeats from the due-date. Normally, when a task is rescheduled it moves forwards by 1 occurrence. If the user has procrastinated, the new due-date could still be in the past. Toodledo will have the option to indicate that certain repeating tasks should be rescheduled to the next future occurance of the task. If this is the case, the custom ";FASTFORWARD" string will be appended to the RRULE. Adding Tasks http //api.toodledo.com/3/tasks/add.php access_token=yourtoken tasks=[{"title" "My Task"},{"title" "Another","star" "1","ref" "98765"},{"title" "","ref" "1234"}] fields=folder,star METHOD POST 一度に登録できるタスクは50個まで "tasks/add.php" API call with an array of tasks. 必須パラメータ title field 任意パラメータ folder, context, goal, location, priority, status,star, duration, remind, starttime, duetime, completed, duedatemod, repeat, tag, duedate, startdate, note, parent, meta (see above for possible values). "ref"という特殊フィールドが用意されている。 同期後のマッチングを助ける refフィールドはタスクにはセーブされない。このAPIをコールした後に帰ってくるのみ。 Tasks are added by creating a JSON object (example below) and submitting a POST to the API. 改行は "\n" で表現する。 記号は %XX 形式で置き換えられるし、スペースは + でエンコードされる。 Each element in the array will be a task object. You only need to set the fields that you want to set. 効率を考えるとセットしたいフィールドだけをセットすべき。 For efficiency, you should try to send only the fields that you are setting. If the action was successful the added tasks will be returned in the same order in which they were added. If there were any errors on individual tasks, they will be output inline with the returned tasks, so you can determine which action failed. You can also specify xml as the output format for any API calls by attaching "f=xml" to the URL. http //api.toodledo.com/3/tasks/add.php access_token=yourtoken Deleting Tasks The "/tasks/delete.php" API call will allow you to permanently delete up to 50 tasks at a time. You can access this via POST. For tasks that the user wants available in the history section, or for tasks that continue to repeat, you should not use this method. Instead, you should edit the task and mark it as completed. Tasks are deleted by submitting a JSON encoded array of id numbers to the API. http //api.toodledo.com/3/tasks/delete.php access_token=yourtoken tasks=["1234"%2C"1235"%2C"5678"] If the action was successful the deleted tasks s id numbers will be returned. If there were any errors on individual tasks, they will be output inline with the returned tasks, so you can determine which action failed. [{"id" 1234},{"id" 1235},{"errorCode" 605,"errorDesc" "Invalid ID number","ref" "5678"}] You can also specify xml as the output format for any API calls. http //api.toodledo.com/3/tasks/delete.php access_token=yourtoken tasks=["1234"%2C"1235"%2C"5678"] f=xml deleted id 1234 /id id 1235 /id Invalid ID number /deleted Get Deleted Tasks The "/tasks/deleted.php" API call will enable you to detect when a task was deleted on Toodledo, so you can also delete the task from your application. You can access this via GET or POST. after A GMT unix timestamp. Used to find tasks with a deletion date and time after this date and time. http //api.toodledo.com/3/tasks/deleted.php access_token=yourtoken after=1234567890 This returns a list of id numbers and datetime stamps. [{"num" 24},{"id" 1234,"stamp" 1234567891},{"id" 1235,"stamp" 1234567892}] You can also specify xml as the output format for any API calls. http //api.toodledo.com/3/tasks/deleted.php?access_token=yourtoken after=1234567890 f=xml deleted num="2" task id 12345 /id stamp 1234567891 /stamp /task task id 67890 /id stamp 1234567892 /stamp /task /deleted Error Codes Any of the API calls can return error messages. Here is a list of the error messages that you may receive from the tasks API endpoints. If there was an error when editing or deleting a task, the id number that you attempted to edit will be included in the error s "ref" field for your reference. 601 Your task must have a title. 602 Only 50 tasks can be added/edited/deleted at a time. 603 The maximum number of tasks allowed per account (20000) has been reached 604 Empty id 605 Invalid task 606 Nothing was added/edited. You ll get this error if you attempt to edit a task but don t pass any parameters to edit. 607 Invalid folder id 608 Invalid context id 609 Invalid goal id 610 Invalid location id 611 Malformed request 612 Invalid parent id 613 Incorrect field parameters 614 Parent was deleted 615 Invalid collaborator 616 Unable to reassign or share task Examples JSON {"errorCode" 601,"errorDesc" "Your task must have a name","ref" 1234} XML error id="601" ref="1234" Your task must have a name /error GT AD ED DN DD SR フィールド 定義 フォーマット、制限 編集 △ ◯ added タスクが追加された日。UNIX時間で表記。 タスクが追加された「時間」は記録されない。常に正午としてカウントされる。 編集 △ ◯ addedby タスクを割り当てたユーザのId (※subscriptionユーザ限定). 編集 ◯ × after この時間以降に更新したタスクを探索 UNIX時間。 編集 △ ◯ attachment 添付アイテムの配列。各アイテムは３つのフィールドを含む。添付アイテムは読み取り専用。アウトラインを参照するidを使えます。リスト(list)、ノート(note)はこのAPIを通して取得可。ファイルは現在読めないが、機能追加準備中。 編集 ○ - - - - × before この時間以前に更新したタスクを探索 UNIX時間。 編集 × ◯ checked Whether the task is completed or not 編集 △ ◯ children このタスクが持つサブタスク数 サブタスク自身や、サブタスクを持たないタスクは0 編集 ◯ comp 未完了、完了の選択。 0 未完のみ、1 完了のみ、無しor-1 両方 編集 × ◯ ◯ completed いつタスクが完了したか 未完了の場合、0.UNIX時間。Toodledoはタスクが完了した「時間」はトラッキングしない。そのため、タスクは正午に完了、として処理される。 編集 △ ◯ ◯ context コンテクストのID番号 コンテクスト割当なしの場合は省略（もしくは0） 編集 △ ◯ ◯ duedate タスクの期限（日） UNIXタイムスタンプ（GMTの正午）タイムスタンプ＝1445172465↓日時（Tokyo）＝2015/10/18 21 47 45 編集 △ ◯ ◯ duedatemod 期限（日）のタイプを示す整数 0 Due By1 Due On (=)2 Due After ( )3 Optionally (?) 編集 △ ◯ ◯ duetime for when the task is due. UNIX時間。設定しなければ0.duedateが設定されず、duetimeのみが設定されていると、1970年1月1日と判断。タイムゾーンにかかわらず、10amは10amと判断。You can convert this timestamp to a GMT string and display the time component without worrying about timezones. 編集 ◯ duration 編集 ○ fields レスポンスに付けて返してほしいフィールド コンマ区切り。レスポンス向上のため、不用なら省略する。 編集 △ ◯ ◯ folder フォルダのID番号 フォルダ割当なしの場合は0もしくは省略。 編集 △ ◯ ◯ goal goalのID番号 goal割当なしの場合は省略（もしくは0） 編集 △ - ● - - × id タスクID アカウントに対してユニークな番号（違うアカウントに対しては、同一のIDに対して異なるタスクがぶら下がる可能性あり。 編集 △ ◯ length タスク達成までの予想時間（分、整数値） 編集 △ ◯ ◯ location 場所のID番号 割当なしの場合は省略（もしくは0） 編集 △ ◯ meta A text for storing metadata about the task. This is useful for syncing data that cannot otherwise be synced to Toodledo. Because of an implementation detail, using the meta field introduces extra latency to each API call, so you should only use this field when necessary. 1,024バイトまで。タスクごとにユニークなIDを持ち、AppIDに対してprivate。ユーザーもAppIDsも個々に入力した値は見られない。 編集 - ◯ modified for when the task was last modified. UNIX時間。 編集 △ ◯ note ノート 32,000 bytesまで。改行コードは\n 編集 ◯ num 取得するタスク数。複数ページで表示する場合などに使用 デフォルト値、最大値ともに1000 編集 △ × order サブタスクの順番 読み取り専用 編集 △ ◯ parent 親タスクのID番号 デフォルト値はO 編集 △ × previous If the task was repeated from another task, this will contain the id number of the previous version of this task. 編集 △ ◯ ◯ priority 優先順位。整数値。 3 = Top2 = High,1 = Medium,0 = Low,-1 = Negative, 編集 △ ◯ ◯ remind リマインダが送られる、タスクの期限までの時間（分）を表す整数値。 0 リマインダなし値の制限：0, 1, 15, 30, 45, 60, 90, 120, 180, 240, 1440, 2880, 4320, 5760, 7200, 8640, 10080, 20160, 43200)。これ以外は近い値に丸め。無料ユーザーは0か60。 編集 △ ◯ ◯ repeat どのようにタスクを繰り返すかを示す文字列 記録を残すため、リピートするタスクが完了した場合ははコピーされたタスクがリストに加えられ、完了タスクに対して、新しいID番号が付与される。繰り返しを中止するには、これに空文字列を設定。記法は※を参照。 編集 △ ◯ shared that indicates if the task is shared as a joint task (Subscription required for user). A boolean (0 or 1) 。読み取り専用 編集 - × sharedowner The user id of the person who owns the task that is being shared with the current user. If the current user is not the owner, then they cannot make changes to the collaboration settings for this task, although they can make other changes. 読み取り専用 編集 - × sharedwith An array of user ids for people that this task is shared with, other than myself and the owner. Read only. 編集 △ ◯ ◯ star スターの有無 0 スターあり1 スターなし 編集 ◯ start スキップするタスク数。複数ページで表示する場合などに使用 デフォルト値は0 編集 △ ◯ ◯ startdate タスクの開始（日） A GMT unix timestamp 編集 △ ◯ ◯ starttime for when the task starts. UNIX時間。 編集 △ ◯ ◯ status タスクのステータスを表す整数値 0 = None, 1 = Next Action,2 = Active, 3 = Planning,4 = Delegated, 5 = Waiting,6 = Hold, 7 = Postponed,8 = Someday, 9 = Canceled,10 = Reference 編集 × ◯ subtask 編集 △ ◯ ◯ tag タグ 複数の場合はコンマで区切る。64文字まで。 編集 △ ● ◯ - - ◯ title タスクタイトル 文字列。255文字まで。 編集 △ ◯ timer The value in the timer field indicates the number of seconds that have elapsed for the timer not including the current session. 編集 × ☓ timeron （タイマーON時）タイマースタート時間のタイムスタンプ Total Time=timer+(now-timeron). Where "now" is a unix timestamp for the current time. 編集 △ ◯ via A read-only field that indicates how the task was added. 読み取り専用-0 Main website-1 Email Import,-2 Firefox Addon-3 This API,-4 Widgets (Google Gadget, etc)-5 Not used,-6 Mobile Phone-7 iPhone App,-8 Import Tools-9 Twitter 編集
https://w.atwiki.jp/api_programming/pages/186.html
https //api.toodledo.com/3/contexts/index.php 概要 コンテクストとはGTDでよく用いられる概念。どの状況でどのタスクをするべきなのか、という考え方。例えば、 work , home , shopping などがよく用いられるコンテクストである。 Jump To Retrieving Contexts Adding Contexts Editing Contexts Deleting Contexts Errors コンテクストの同期 Syncing contexts is fairly straight forward. The first thing to do is add any new contexts you have created and delete any contexts that you have deleted. Then, look at the "lastedit_context" timestamp returned from Account Info to determine if any changes have happened on the server since the last time you synced. If yes, then you need to fetch the contexts from the server and integrate this into your local copy. This is where you would do conflict resolution if a context was edited in both places. After this, if you have any contexts that you edited, you can send these edits up to the server. Sync Flowchart コンテクストの取得 contexts/get.php GET or POST. 使っているコンテクストのリストが返ってくる名前とID番号が入っている http //api.toodledo.com/3/contexts/get.php?access_token=yourtoken This call will return a JSON encoded object that looks like this. response id 123 name Work private 0 [{"id" 123,"name" "Work","private" 0},{"id" 456,"name" "Home","private" 1},{"id" 789,"name" "Car","private" 0}] You can also specify xml as the output format for any API calls by attaching "f=xml" to the URL. http //api.toodledo.com/3/contexts/get.php?access_token=yourtoken f=xml contexts context id 123 /id name Work /name private 0 /private /context context id 456 /id name Home /name private 1 /private /context context id 789 /id name Car /name private 0 /private /context /contexts Adding Contexts Add a context using the "contexts/add.php" API call. You can access this via POST. Context names must be unique within an account. If you try to add a context that already exists, you ll get an error. Each user can have up to 1000 contexts. If you try to add more than this, you will get an error. name A text string up to 32 characters. (required) private A boolean value (0 or 1) that describes if this context can be shared. A value of 1 means that this context is private. http //api.toodledo.com/3/contexts/add.php name=MyContext access_token=yourtoken If the add was successful the new context will be returned. [{"id" 12345,"name" "MyContext","private" 0}] contexts context id 12345 /id name MyContext /name private 0 /private /context /contexts Editing Contexts Edit a context using the "contexts/edit.php" API call. You can access this via POST. Context names must be unique within an account. If you try to edit the context name to one that already exists, you will get an error. If you try to edit the context, but pass in the same values that already exist on the server, you will get an error. You should avoid making unnecessary edits. id The id number of the context to edit. (required) name A text string up to 32 characters. (required) private A boolean value (0 or 1) that describes if this context can be shared. A value of 1 means that this context is private. http //api.toodledo.com/3/contexts/edit.php id=12345 name=MyContext access_token=yourtoken If the edit was successful the edited context will be returned. [{"id" 12345,"name" "MyContext","private" 0}] contexts context id 12345 /id name MyContext /name private 0 /private /context /contexts Deleting Contexts The "contexts/delete.php" API call will allow you to permanently delete a context. You can access this via POST. Any tasks that have this context will have their context set to "none". id The id number of the context to delete. (required) http //api.toodledo.com/3/contexts/delete.php id=12345 access_token=yourtoken If the delete was successful you will get the following message. {"deleted" 12345} deleted 12345 /deleted Error Codes Any of the API calls can return error messages. Here is a list of the error messages that you may receive from the contexts API endpoints. If there was an error when editing or deleting a context, the id number that you attempted to edit will be included in the error s "ref" field for your reference. 301 Your context must have a name. 302 A context with that name already exists. 303 Max contexts reached (1000). 304 Empty id. 305 Invalid context. 306 Nothing was edited. Examples {"errorCode" 302,"errorDesc" "A context with that name already exists","ref" 1234} error id="302" ref="1234" A context with that name already exists /error Privacy · Terms · Copyright Toodledo © 2004-2016
https://w.atwiki.jp/api_programming/pages/109.html
下位ページ Content Folder（フォルダ）とは？ 同期 フォルダの取得レスポンスJSON XML Folder（フォルダ）とは？ タスクやノートをグループで管理する手段の一つ。 違うプロジェクトや役割を分けるために用いられることが多い。 Jump To Retrieving Folders Adding Folders Editing Folders Deleting Folders Errors 同期 至極単純。 （クライアント側で）新しく作ったフォルダを加えて、（クライアント側で）削除したフォルダを削除する。 最終更新の時間を確認して、サーバ上に何か変更が加えられているか確認するYESなら、サーバ上の情報を取得し、ローカル（クライアント）にコピーする。サーバ、クライアント（と別のクライアント）で変更が加えられていた場合の、コンフリクト解消のため。 この後、何かフォルダが編集されたら、編集情報をサーバに送信。 フォルダの取得 http //api.toodledo.com/3/ bold(){folders/get.php}?access_token=yourtoken アクセス方法 GET or POST. The private boolean value indicates that the user does not want the folder to be shared with other people. The archived boolean value indicates that the user no longer wants to see this folder, but wants to retain it for historical purposes. The order integer represents the user s preferred order for listing folders with ord=1 being the top. レスポンス JSON [{"id" 123,"name" "Shopping","private" 0,"archived" 0,"ord" 1},{"id" 456,"name" "Home Repairs","private" 0,"archived" 0,"ord" 2},{"id" 789,"name" "Vacation PLanning","private" 0,"archived" 0,"ord" 3}] XML URLに f=xml オプションを付けるhttp //api.toodledo.com/3/folders/get.php?access_token=yourtoken f=xml folders folder id 123 /id private 0 /private archived 0 /archived order 1 /order name Shopping /name /folder folder id 456 /id private 0 /private archived 0 /archived order 2 /order name Home Repairs /name /folder folder id 789 /id private 1 /private archived 0 /archived order 3 /order name Vacation Planning /name /folder /folders Adding Folders Add a folder using the "folders/add.php" API call. You can access this via POST. Folder names must be unique within an account. If you try to add a folder that already exists, you ll get an error. Each user can have up to 1000 folders. If you try to add more than this, you will get an error. name A text string up to 32 characters. (required) private A boolean value (0 or 1) that describes if this folder can be shared. A value of 1 means that this folder is private. http //api.toodledo.com/3/folders/add.php name=MyFolder access_token=yourtoken If the add was successful the new folder will be returned. [{"id" 12345,"name" "MyFolder","private" 0,"archived" 0,"ord" 1}] folders folder id 12345 /id private 0 /private archived 0 /archived order 1 /order name MyFolder /name /folder /folders Editing Folders Edit a folder using the "folders/edit.php" API call. You can access this via POST. Folder names must be unique within an account. If you try to edit the folder name to one that already exists, you will get an error. If you try to edit the folder, but pass in the same values that already exist on the server, you will get an error. You should avoid making unnecessary edits. id The id number of the folder to edit. (required) name A text string up to 32 characters. private A boolean value (0 or 1) that describes if this folder can be shared. A value of 1 means that this folder is private. archived A boolean value (0 or 1) that describes if this folder is archived. http //api.toodledo.com/3/folders/edit.php id=12345 name=MyFolder private=0 access_token=yourtoken If the edit was successful the edited folder will be returned. [{"id" 12345,"name" "MyFolder","private" 0,"archived" 0,"ord" 1}] folders folder id 12345 /id private 0 /private archived 0 /archived order 1 /order name MyFolder /name /folder /folders Deleting Folders The "folders/delete.php" API call will allow you to permanently delete a folder. You can access this via POST. Any tasks or notes that currently have this folder will have their folder set to 0 (none). id The id number of the folder to delete. (required) http //api.toodledo.com/3/folders/delete.php id=12345 access_token=yourtoken If the delete was successful you will get the following message. {"deleted" 12345} deleted 12345 /deleted Error Codes Any of the API calls can return error messages. Here is a list of the error messages that you may receive from the folder API endpoints. If there was an error when editing or deleting a folder, the id number that you attempted to edit will be included in the error s "ref" field for your reference. 201 Your folder must have a name. 202 A folder with that name already exists. 203 Max folders reached (1000). 204 Empty id. 205 Invalid folder. 206 Nothing was edited. Examples JSON {"errorCode" 202,"errorDesc" "A folder with that name already exists","ref" 1234} XML error id="202" ref="1234" A folder with that name already exists /error
https://w.atwiki.jp/abwiki/pages/605.html
初心者向けの解説。 APIっていうのはね、 アプリを作るためにOSが用意した関数のこと。 システムコールと同じような意味。 上級者向けの解説。 APIっていうのはね。 アプリ開発のインタフェース。 Cに置いては、関数やマクロである。 バッチファイルではコマンドがAPIになる。 UnixやLinuxのシステムコールとの違いは、 システムコールは完全にOSへの命令であるのに対し APIは、システムコールを含めた、アプリ開発の便利な命令、関数、その他もろもろをふくんでいる。