Search Results: tag:API

17 件ヒットしました。 1 - 10 番目を表示しています。

cmdnote API 記事を投稿する

URL
http://cmdnote.net/api/items
method
POST
parameter
text

パラメータ text に cmdnote の形式のテキストを指定する。

投稿に成功した場合は、作成された記事が返信されます。 テキストが正しくなく、投稿に失敗した場合はステータスコード 422 を返します。

{
    "id":890004423,
    "title":"Title",
    "content":"Content\n",
    "created_at":"2012-01-28T12:39:01Z",
    "updated_at":"2012-01-28T12:39:01Z",
    "author":"Author",
    "tags":["Tag"]
}

cmdnote API 記事を取得する

URL
http://cmdnote.net/api/items/ITEM_ID
method
GET

ITEM_ID に記事の ID を指定する。 記事が存在すれば JSON で返答します。記事が存在しなければ ステータスコード 404 を返します。

{
    "id":890004423,
    "title":"Title",
    "content":"Content\n",
    "created_at":"2012-01-28T12:39:01Z",
    "updated_at":"2012-01-28T12:39:01Z",
    "author":"Author",
    "tags":["Tag"]
}

cmdnote API 記事を更新する

URL
http://cmdnote.net/api/items/ITEM_ID
method
PUT
parameter
text

ITEM_ID に記事の ID を指定する。 パラメータ text に cmdnote の形式のテキストを指定する。

更新が成功すれば更新された記事を返します。 指定した ID の記事が存在しない場合はステータスコード 404、 他のユーザの記事を更新しようとした場合はステータスコード 403、 更新に失敗した場合はステータスコード 422 を返します。

{
    "id":890004423,
    "title":"Title",
    "content":"Content\n",
    "created_at":"2012-01-28T12:39:01Z",
    "updated_at":"2012-01-28T12:39:01Z",
    "author":"Author",
    "tags":["Tag"]
}

cmdnote API 記事を削除する

URL
http://cmdnote.net/api/items/ITEM_ID
method
DELETE

ITEM_ID に記事の ID を指定する。

削除が成功すればステータスコード 200、 指定した ID の記事が存在しない場合はステータスコード 404、 他のユーザの記事を更新しようとした場合はステータスコード 403、 削除に失敗した場合はステータスコード 422 を返します。

cmdnote API 検索する

URL
http://cmdnote.net/api/search
method
GET
parameter
q、count、page、order、lang、created_after、created_before、updated_before、updated_before

パラメータ q に指定されたクエリ(必須)で検索した結果を JSON で返します。 count には1ページの項目数(最大で200)、page にはページ番号、 order には項目の順序として score、create_asc、create_desc, update_asc、update_desc のいずれかを指定する。 lang には ja または en を指定することができる。 created_after、created_before、updated_before、updated_before は 作成時刻または更新時刻で検索対象をしぼり込む。

{
    "query":"cmdnote",
    "hit":5,
    "page":1,
    "max_page":2,
    "item_start":1,
    "item_end":3,
    "items":[
	{
	    "id":11,
	    "title":"ユーザーで検索する",
	    "content":"「user:cmdnote」とすると作成したユーザ名が cmdnote の記事だけにヒットします。\n",
	    "created_at":"2012-01-31T07:51:55Z",
	    "updated_at":"2012-01-31T07:51:55Z",
	    "author":"cmdnote",
	    "tags":["cmdnote","query"]
	},
	{
	    "id":13,
	    "title":"記事を投稿する",
	    "content":"[URL] http://cmdnote.net/api/items\n[method] POST\n[parameter] text\n",
	    "created_at":"2012-01-31T07:51:55Z",
	    "updated_at":"2012-01-31T07:51:55Z",
	    "author":"cmdnote",
	    "tags":["cmdnote","API"]
	}
    ]
}

cmdnote API プロフィールを取得する

URL
http://cmdnote.net/api/profile
method
GET
parameter
user

user に指定したユーザー名のプロフィールを取得します。 user に指定がない場合は アクセスしているアカウントのプロフィールを取得します。 自身のプロフィールについては email を取得できますが、 他のユーザーの email は取得することができません。

{
    "name":"cmdnote",
    "url":"http://example.com/",
    "profile":"Description of profile",
    "lang":"ja",
    "email":"cmdnote@example.com"
}
{
    "name":"cmdnote",
    "url":"http://example.com/",
    "profile":"Description of profile",
    "lang":"ja"
}

cmdnote API 他のユーザのプロフィールを取得する

URL
http://cmdnote.net/api/profiles/USERNAME
method
GET
parameter
url、profile、email、lang

ユーザ名 USERNAME のプロフィールを取得します。

cmdnote API プロフィールを更新する

URL
http://cmdnote.net/api/profile
method
POST
parameter
url、profile、email、lang

アクセスしているアカウントのプロフィールを更新します。 パラメータとして url、profile、email、lang を指定します。

{
    "name":"cmdnote",
    "url":"http://example.com/",
    "profile":"Description of profile",
    "lang":"ja",
    "email":"cmdnote@example.com"
}
{
    "name":"cmdnote",
    "url":"http://example.com/",
    "profile":"Description of profile",
    "lang":"ja"
}

cmdnote API ノートの一覧を取得する

URL
http://cmdnote.net/api/notes
method
GET
parameter
user

パラメータ user にユーザ名を指定します。 指定したユーザのノートのリストを取得します。 ユーザが指定されていない場合は、自身のノートのリストを取得します。

cmdnote API ノートの設定を取得する

URL
http://cmdnote.net/api/notes/NOTE_ID
method
GET

ノートのタイトル、説明、著者、作成日時、更新日時を取得します。