Croudia REST API

Croudia REST APIを使うとCroudiaからタイムライン等の取得やCroudiaへの投稿ができます。

認証

本APIはOAuthによるユーザー認証に対応しています。全てのAPIの呼び出しにはOAuth認証が必要になります。

注意事項

APIの仕様は予告なく変更される可能性があります。



認証確認
account/verify_credentials
認証情報を確認する
※認証に成功するとリクエストしたユーザーのuserオブジェクトを返します


タイムライン取得
statuses/public_timeline
パブリックタイムラインを取得する

statuses/home_timeline
ホームタイムラインを取得する

statuses/user_timeline
ユーザータイムラインを取得する

statuses/mentions
@返信を取得する


投稿
statuses/update
投稿(ささやき)する

statuses/update_with_media
画像付きの投稿(ささやき)をする

statuses/destroy/:id
投稿(ささやき)を削除する
※シェアの解除およびシェア&投稿の削除もこのAPIを使用します

statuses/show/:id
投稿(ささやき)の詳細情報を取得する


シークレットメール
secret_mails
受信したシークレットメールを取得する

secret_mails/sent
送信したシークレットメールを取得する

secret_mails/new
シークレットメールを送信する

secret_mails/new_with_media
画像付きのシークレットメールを送信する

secret_mails/destroy/:id
シークレットメールを削除する

secret_mails/show/:id
指定したIDのシークレットメールを取得する

secret_mails/get_secret_photo/:id
シークレットメールに添付された画像を取得する


ユーザー情報
users/show
ユーザーの情報を取得する

users/lookup
複数ユーザーの情報を取得する


各種設定
account/update_profile_image
アイコン画像を変更する

account/update_cover_image
カバー画像を変更する

account/update_profile
プロフィールを変更する


フォロー管理
friendships/create
フォローする

friendships/destroy
フォローを解除する

friendships/show
ユーザーの関係を調べる

friendships/lookup
フォロー関係一覧を取得する

friends/ids
フレンドのユーザーID一覧を取得する

followers/ids
フォロワーのユーザーID一覧を取得する

friends/list
フレンドのユーザーオブジェクト一覧を取得する

followers/list
フォロワーのユーザーオブジェクト一覧を取得する


お気に入り
favorites
お気に入り一覧を取得する
※現在、このAPIはご利用できません。

favorites/create/:id
お気に入りを追加する

favorites/destroy/:id
お気に入りを解除する


シェア
statuses/spread/:id
シェアする
※シェア解除は、投稿削除(statuses/destroy/:id)をご利用ください


コメント
statuses/comment
コメントする
※コメント削除は、投稿削除(statuses/destroy/:id)をご利用ください

statuses/comment_with_media
コメントする(投稿に画像を添付する)


トレンド
trends/place
現在のトレンドを取得する


ミュート
mutes/users/create
ミュートする

mutes/users/destroy
ミュートを解除する

mutes/users/list
ミュートしているユーザー一覧を取得する

mutes/users/ids
ミュートしているユーザーID一覧を取得する


ブロック
blocks/create
ブロックする

blocks/destroy
ブロックを解除する

blocks/list
ブロックしているユーザー一覧を取得する

blocks/ids
ブロックしているユーザーID一覧を取得する


検索
search/voices
ささやき(投稿)を検索する

users/search
ユーザーを検索する

profile/search
プロフィールを検索する

search/favorites
お気に入りを検索する


解説
OAuthの設定方法
OAuthの設定方法を解説します

【パラメータ】statusオブジェクト関連パラメータ
statusオブジェクトを返すメソッドでサポートしているパラメータを解説します

【パラメータ】ページ処理関連パラメータ
オブジェクトを複数回リクエストする方法を解説します

【パラメータ】検索関連パラメータ
検索関連のパラメータについて解説します。

【戻り値】statusオブジェクト
投稿(ささやき)1つを表すオブジェクトについて解説します

【戻り値】sourceオブジェクト
クライアントの情報を表したオブジェクトについて解説します

【戻り値】entitiesオブジェクト
投稿に含まれる画像等の付加情報を表したオブジェクトについて解説します

【戻り値】userオブジェクト
特定ユーザーの情報を表したオブジェクトについて解説します

【戻り値】secretmailオブジェクト
シークレットメール1つを表すオブジェクトについて解説します

【戻り値】trendオブジェクト
トレンドに関連した情報を表すオブジェクトについて解説します

【戻り値】search metadataオブジェクト
ささやき検索の戻り値に含まれるオブジェクトについて解説します。

REST APIのレスポンスコード
REST APIが返すコードについて解説します