Thanks

言語

Total
30975 Thanks

THANKSではAPIを公開しています。
「ありがとう」をつかったサービスを検討されている
技術者のかたはこちらをご覧ください。

THANKS APIキーの発行

サンクスAPIについて

サンクスメッセージを取得・投稿・削除する事ができます。
登録ユーザとゲストユーザのそれぞれで投稿することが可能です。

投稿制限

サンクスメッセージは1日に10件まで投稿することができます。
ゲストユーザによる投稿は日毎の制限はありませんが、最大投稿数は500件までとなります。
使用できる文字コードはUTF-8になります。

APIキーの発行

利用するためにはサンクスアカウントが必要です。
登録ページからユーザ登録を行ってください。
登録後、発行ページからメールアドレスを入力していただくと、登録されたメールアドレスにAPIキーが送られます。
また、APIキーの再発行を行うと、以前使用されていたものは無効となります。
再発行した際には新規のAPIキーを使うようにしてください。

サンクスメッセージの投稿

サンクスメッセージを投稿します。

url http://thanks.kayac.com/api/pub/say/thanks
メソッド POST
引数
api_key
APIキー
to_name
対象
body
メッセージ内容
public_yn
公開設定(y,n) yを指定した場合にはサンクスページに掲載されます
tag
タグ(スペース区切りで指定)

以下のようなJSON形式の値を返します。

戻り値
失敗
{"action":"pub:sayThanks","status":403}
成功
{"id":9999,"result":"success","status":201}

ゲストメッセージの投稿

ゲストユーザとしてメッセージを投稿します。

url http://thanks.kayac.com/api/pub/say/guest_thanks
メソッド POST
引数
api_key
APIキー
to_name
対象
guest_name
ゲストユーザ名
body
メッセージ内容
public_yn
公開設定(y,n) yを指定した場合にはサンクスページに掲載されます
tag
タグ(スペース区切りで指定)

以下のようなJSON形式の値を返します。

戻り値
失敗
{"action":"pub:sayGuestThanks","status":403}
成功
{"id":9999,"result":"success","status":201}

ユーザメッセージの取得

投稿したメッセージを取得します。ページ数を指定して10件づつ取得することができます。

url http://thanks.kayac.com/api/pub/read/thanks
メソッド GET,POST
引数
api_key
発行されたAPIキー
ページ
ページ

以下のようなJSON形式の値を返します。

戻り値
失敗
{"action":"pub:readThanks","status":403}
成功
 
{
    "result": "success",
    "total_results": 20,
    "start_index": 1,
    "items_per_page": 1,
    "entry":[
        {
            "id": 1,
            "to_name": "カヤック",
            "guest_name": null,
            "body": "ありがとう!",
            "public_yn": "y",
            "language": "ja",
            "tag": "thanks kayac"
        },
        :
    ]
}

ゲストメッセージの取得

ゲストが投稿したメッセージを取得します。ページ数を指定し10件づつ取得することができます。

url http://thanks.kayac.com/api/pub/read/guest_thanks
メソッド GET,POST
引数
api_key
発行されたAPIキー
ページ
ページ

以下のようなJSON形式の値を返します。

戻り値
失敗
{"action":"pub:readGuestThanks","status":403}
成功
 
{
    "result": "success",
    "total_results": 20,
    "start_index": 1,
    "items_per_page": 1,
    "entry":[
        {
            "id": 1,
            "to_name": "カヤック",
            "guest_name": "訪問者",
            "body": "ありがとう!",
            "public_yn": "y",
            "language": "ja",
            "tag": "thanks kayac"
        },
        :
    ]
}

メッセージの削除

idを指定し投稿したメッセージを削除します

url http://thanks.kayac.com/api/pub/delete/thanks
メソッド POST
引数
api_key
発行されたAPIキー
id
メッセージID

以下のようなJSON形式の値を返します。

戻り値
失敗
{"action":"pub:deleteThanks","status":403}
成功
{"id":9999,"result":"success","status":200}