【2016年12月版】Misskey APIの叩き方

2016年12月25日 15時51分 スルメ Misskey

misskey.xyzがいつの間にか新しくなったのでMisskeyAPIの叩き方を紹介します!

 

1. アプリの作成

https://dev.misskey.xyz/apps の「アプリ作成」からアプリを作成します。

今のところここでする設定はすべて変えられないのでtypoには気をつけよう!

どうにかしてアプリを作ったら、App Secretの下になんかテキストボックスがあるページに飛ぶと思います。これがApp Secretです。大事にしましょう。

2. ユーザーに認証させる

https://api.misskey.xyz/auth/session/generateにPOSTリクエストを送信します。

formにapp_secretを含めてください。

そうすると{"token":"hogehogehogehoge"}みたいなJSONが降ってくるので、tokenの中身をhttps://auth.misskey.xyz/に付け足して(例: https://auth.misskey.xyz/hogehogehogehoge)、Webブラウザで表示してください(WebView内でも構いませんが、信頼性やパスワードを打つ手間を考えるとOSの設定で指定されているブラウザで開くのが好ましいです。iOSならSFSafariViewControllerでもいいかもしれません)

ユーザーが許可したことをボタンなどで確認したら、https://api.misskey.xyz/auth/session/userkey

  • app_secret
  • token

をPOSTしてください。

認証されていれば{"userkey":"piyopiyo"}のようなレスポンスが返ってくるので、これ以降はこのuserkeyを_userkeyとしてPOSTパラメータに含めます。

なお、Misskey APIは原則としてすべてPOSTリクエストです。

2.5 自分だけ使うアプリの場合

自分だけ使うアプリの場合、https://misskey.xyz→設定→APIから自分だけのトークンが生成できます。(これをユーザーに入力させることはしないでください。これは自分用アプリのみに利用するべきです。)

これを使う場合は、_userkeyではなくiとしてリクエストに含めてください。

3. 実際にAPIを叩いてみる

先程の認証情報を含めて、https://api.misskey.xyz/iにPOSTリクエストを送ってみましょう。

以下のようなレスポンスが返ってくるはずです。

以上のようなレスポンスが帰ってきましたか?

おめでとうございます!あなたはAPIを叩くのに成功しました。

うまくいかない場合は、どこかでtypoしていないかなどを気をつけてみてください。どうしてもうまくいかない場合は、@surumeまでリプライをくださればサポートをしてくれるかもしれません。

API一覧はこのへん、APIの挙動やパラメータはこのへんを参考にしてください。