MisskeyやSpotifyのAPIで投稿を消したり投げたりする処理をGoで実装する際に詰まった部分のメモ

2023年12月1日にQiitaで公開していた記事のアーカイブです。

冬ですね。非常に寒くて足の指先が変な色しています。 最近APIを使って何らかの処理をしていくのにハマっています。

僕は当初PythonでTwitterのAPIを使って時報や投稿の一括消去を行ってみたりして楽しんでいたんですけど、残念なことに2022年の12月にすべてのアカウントが言われもない閉鎖処理に遭ってしまい、アカウントを作り直したのにもかかわらずAPI有料化騒動が出てしまい、流石にもげました。

しかし、APIの快楽を味わってしまったのでどこかで摂取したいという動機は収まらず（禁断症状）同じことをMisskeyでも出来ないかと思って挑戦してみました。

色々悩んだ結果11月の間に3つ出来たんですけど、その中の一つである「Misskeyで投稿したコンテンツを抹消するAPI」をテストしたら当たり前のように全部投稿が消えちゃったので、色々苦戦した記録が消し飛んでしまいました（苦笑）

今回はまだ記憶が残ってるうちにMisskeyやSpotifyのAPIに関する認証部分、投稿部分で詰まったことや悩んだことを整理しておいて、今後また作るときに確認するチートシートにしておきたいと思います。

今回も例の如くGoで書きました。ﾋﾟｷﾞﾓﾝｺﾞ

認証

Misskey

https://misskey-hub.net/docs/api/

MisskeyでAPIを使うためには対応するサーバーのアクセストークンの取得が必須です。 アクセストークンの発行手段はMisskeyの自アカウントの設定欄から手動で取得する方法とOauth2.0を使ってアクセスする手法の二種類が存在します。 今回は自分で利用するだけという点もあり比較的楽な手動発行方式を採用しました。

初期の実装は毎回入力させるタイプで書いてみました。

func oauth() string {
    var token, host string

    fmt.Println("トークンを設定してください。")
    token = readInput("Token: ")

    fmt.Println("サーバーのホストを設定してください。")
    host = readInput("Host: ")

 endpoint = "https://" + host + "/api/"

    return token
}

①ターミナル上に入力を促す表示を出し、ユーザーに入力させる。 ②入力させた情報をエンドポイントの形にして成形する ③POST処理に渡して実行する

という形です。

基本的にはこれで問題ないんですけど、毎回処理を走らせるたびにトークンとホスト名を入力していると非常に面倒だなと思ったので、もうファイルの中に保持してしまおうかという考えに至りました。

しかしながらファイル内に直接トークンのような機密情報を保持させてしまうと、チラリズムどころの話ではなく電子露出狂になってしまう懸念があったので、コード本体に埋め込むのではなく、環境変数を使うように方向転換しました。

.envファイルを使用した場合、git等のリポジトリに公開する際に.gitignoreで該当するファイルを除外できる点や、今後DevブランチやTestブランチを作って異なる環境変数が登場した際に一括して管理することが出来るので、テストやデバッグにも最適です。 何よりも毎回入力する必要が無いのが非常に助かりますね。

今回はGo向けの外部パッケージで.env ファイルから環境変数を読み込むためのツールとして検索に引っかかったgodotenvを使用させていただきました。

godotenvをインポートするとこんな感じでファイル経由で環境変数が読み取れるようになるので非常に便利です。

package main

import (
    "log"
    "os"

    "github.com/joho/godotenv"
)

func main() {
  err := godotenv.Load()
  if err != nil {
    log.Fatal(".envファイルが見つからないよ")
  }

  loginID := os.Getenv("YAH_YAH_YAH")
  logginSECRET := os.Getenv("DO_YA_DO")

}

Misskeyの場合はホスト名とトークンを入力することになるので、このように改造しました。

func oauth() string {
    err := godotenv.Load()
    if err != nil {
        fmt.Println(".envファイルが見つからないか読み込めません")
        return ""
    }

    token := os.Getenv("TOKEN")
    host := os.Getenv("HOST")

    if token == "" || host == "" {
        fmt.Println("トークンとホストを正しく設定してください。")
        return ""
    }

    endpoint = "https://" + host + "/api/"

    fmt.Println("Endpoint:", endpoint)
    return token
}

ファイルが見つからないことに加え、どちらかを欠落させてしまう可能性があるかもしれないので色々警告文を出していますが、エンドポイントに引き渡す処理は前回と同様のままで問題ありません。

あとはmain関数の部分でMisskeyが指定するiのパラメーターにoauth()で入力されたトークンを渡すと、認証が通るようになります。

func main() {
    token := oauth()
    me, err := FetchUser("i", map[string]interface{}{"i": token})
    if err != nil {
        fmt.Println("照会中にエラーが発生しました:", err)
        return
    }

Spotify

SpotifyのAPIを使用する場合、OAuth 2.0認証プロセスを通じてアクセストークンaccess_tokenとリフレッシュトークンrefresh_tokenを取得します。(これがなかなかにキツかった...)

Spotifyのアクセストークンは一時間で死んでしまうため、リフレッシュトークンを使って定期的に蘇生することになります。リフレッシュトークンがあるといちいちユーザーに再度許可を求めなくてもアクセストークンが発行できるので非常に便利です。

しかし、SpotifyのDevダッシュボードで確認できるのはClientIDとClientSecretだけです。 そのため、 ClientIDとClientSecretを使用して→リフレッシュトークン発行コードを取得→リフレッシュトークンを取得→アクセストークンの取得というプロセスを踏むことになります。

https://github.com/yude/np2mast

ここの処理に関してはYudeさんという開発者の方が1年ほど前にMastodonで再生中の曲を送信する処理を書かれているのを大いに参考にしました。

初期の段階ではインポートして必要な情報を書き込んだのに何故か401エラーが出てしまったので悩んでいたところ、リフレッシュトークン発行コードを取得するプロセスでスコープを指定する部分が取れてしまっていたので、こちらを追加してMisskey向けに改造しました。

values.Add("scope", "user-read-playback-state user-read-currently-playing")

//envファイルから読み取る部分
values.Add("client_id", os.Getenv("SPOTIFY_CLIENT_ID"))
        values.Add("response_type", "code")
        values.Add("redirect_uri", "http://localhost:3000/callback")
        values.Add("scope", "user-read-playback-state user-read-currently-playing")
        fmt.Println("https://accounts.spotify.com/authorize?" + values.Encode())

//URLにアクセスしてコードを取得する部分
func spotify_login(w http.ResponseWriter, req *http.Request) {
    values := url.Values{}
    values.Add("client_id", os.Getenv("SPOTIFY_CLIENT_ID"))
    values.Add("response_type", "code")
    values.Add("redirect_uri", "http://localhost:3000/callback")
    values.Add("scope", "user-read-playback-state user-read-currently-playing")

    http.Redirect(w, req, "https://accounts.spotify.com/authorize?"+values.Encode(), http.StatusFound)
}

送信、消去の処理

Misskeyで投稿を送信、消去する場合は、エンドポイントに適切なパラメータでjson形式のデータを送信します。 エンドポイントは各操作ごとに明確に分かれていて、リクエスト処理がPOSTかGETかという点に関しても強く意識する必要があります。

https://misskey-hub.net/docs/api/endpoints/notes/create.html

詳細な点はエンドポイント一覧をご参照ください。

例えば、送信処理の場合は

func postToMisskey(message string) error {
    misskeyURL := os.Getenv("MISSKEY_ENDPOINT_URL") + "/api/notes/create"
    //ここでエンドポイントを指定。"/api/notes/create"が現行の投稿作成のエンドポイント

    requestData := map[string]string{
        "i":          os.Getenv("MISSKEY_ACCESS_TOKEN"),
        "text":       message,
        "visibility": "home",
    }
    //ここでエンドポイントが要求する適切なパラメータを設定していなければUnauthorizedエラー(401)が出てしまいます。

    jsonData, err := json.Marshal(requestData)
    if err != nil {
        return fmt.Errorf("リクエストデータのJSONエンコードに失敗しました。: %v", err)
    }

    resp, err := http.Post(misskeyURL, "application/json", bytes.NewBuffer(jsonData))
    if err != nil {
        return fmt.Errorf("ノートに失敗しました。: %v", err)
    }
    defer resp.Body.Close()

    if resp.StatusCode != http.StatusOK {
        body, _ := io.ReadAll(resp.Body)
        log.Printf("Failed to post to Misskey. Status: %d. Response: %s", resp.StatusCode, string(body))
        return errors.New("ノートに失敗しました")
    }

    return nil
}

僕の場合「トークンがあってるのに認証されないっ...！何故！」という点で非常に詰まってしまってしまい、適切なパラメータが設定されていないことに時間がかかってしまいました。 要するにここの実装が抜けていて、直接エンドポイントに文字列を送ろうとしたわけですね。

    requestData := map[string]string{
        "i":          os.Getenv("MISSKEY_ACCESS_TOKEN"),
        "text":       message,
        "visibility": "public",
    }

    jsonData, err := json.Marshal(requestData)
    if err != nil {
        return fmt.Errorf("リクエストデータのJSONエンコードに失敗しました。: %v", err)
    }

    resp, err := http.Post(misskeyURL, "application/json", bytes.NewBuffer(jsonData))
    if err != nil {
        return fmt.Errorf("ノートに失敗しました。: %v", err)
    }
    defer resp.Body.Close()

送信先のMisskeyは厳格にデータの扱いを決めているため、単純な文字列の挿入では送信できないようになっています。逆にこれがあるから変なデータが送り付けられないという点があり非常に助かりますね。

投稿の取得やノートの消去も同様です。

func GetUsersNotes(userId, untilId, token string) ([]Note, error) {
    args := map[string]interface{}{}
    if untilId == "" {
        args = map[string]interface{}{
            "userId": userId,
            "limit":  100,
            "i":      token,
            "withChannelNotes": true,
        }
    } else {
        args = map[string]interface{}{
            "userId":  userId,
            "untilId": untilId,
            "limit":   100,
            "i":       token,
            "withChannelNotes": true,
        }
    }

    notes, err := FetchNotes("users/notes", args)
    return notes, err
}

func DeleteNote(noteId, token string) error {
    args := map[string]interface{}{
        "noteId": noteId,
        "i":      token,
    }

    return Post("notes/delete", args, nil)
}

尚、いちいちJson形式に直すのは非常に億劫だと思うので、Goではユーザー、ノート、エラー毎に構造体を持たせて一元管理する方法が便利です。

type User struct {
    Name        string `json:"name"`
    Username    string `json:"username"`
    NotesCount  int    `json:"notesCount"`
    Id          string `json:"id"`
    PinnedNotes []Note `json:"pinnedNotes"`
}

type Note struct {
    Id        string    `json:"id"`
    CreatedAt time.Time `json:"createdAt"`
}

type Error struct {
    Message string `json:"message"`
    Code    string `json:"code"`
    Id      string `json:"id"`
    Kind    string `json:"kind"`
}

このように管理しておけば、同様の処理を何度も記述する必要がありません。

補足

API使用時の作法として、MisskeyやMastodonは個人で運営しているサーバーが多いことから、APIを一度に大量にリクエストしてしまうと運営者のサーバーに負荷をかけてしまいます。

一応どちらにもリクエスト制限が設けられていて、平均的には300リクエストぐらいすると1時間のインターバルを設けるように設定してあるのですが、何度も同じ場所からリクエストされるとお行儀が悪いのと、コストの無駄が考えられます。

ぶっちゃけ同一の送信元から何度もリクエストしてるのを見られると「こいつDOSんちゅだな...」と解釈してIPBANされかねません。

そのため、リクエスト制限がかかったら何度もリクエストしないようにブランクタイムを設けておくのが有効です。

例えばGoの標準ライブラリにあるtimeをインポートしておいて

time.Sleep(30 * time.Minute)

のように設定しておけば30分間送信処理を中断することが出来ます。

感想

今まではローカル環境で処理を行うものだけを書いてきたのもあって、送信先の事を配慮した実装に関しては意識できていなかったのですが、1か月を通してAPIの実装を学んだことでお行儀のよい通信とは何かを意識するようになりました。

今後もチャンネルのノートを消す実装だったり、ゴルーチンがこけた時に復帰させる処理を追加する等、やりたいことがいっぱいあるので、日々精進して参ります。

よくGoで書くとエラーハンドリングがどうしても面倒くさいという意見を頂くのですが、僕は諸学者なのでどういったエラーなのかを言葉で説明できるアウトプットの場になるのですごく助かっています。

今後もゴーファー君を愛でつつ2024年を迎えていきたいと思います。よいお年を！（早い）