初めてAPIを扱うときの考え方

当サイトではアフィリエイト広告を利用して商品を紹介しています。

Twitter Slack kintone BacklogChatWorkなどなど
一応いろんなAPIを触った経験から汎用的なAPIの使い方を自分なりにまとめてみます。

「公式」のチュートリアルを読む。

「公式」のが重要です。 ここで必要なものは何なのか?をざっと確認。 特にハマりポイントになりやすい認証に関しては目を通しておきましょう。

・トークンの取得の仕方は? ・認証の方法は? ・パーミッション(権限)の設定

・公式が推奨しているライブラリはないか?

ほとんどの場合、GASのライブラリはないので、GASで使おうとすると自分でコードを書いていくことになりますが、curl コマンドで書かれたサンプルコードを読み解いて行くことになります。

非公式の日本語で解説されているものを探す。

1が読めなかったり分からなかった場合に、 ただし、時期に注意。APIの仕様は変わることが有るので、古い記事だとそのまま動かないことや、推奨されないエンドポイントを使い続けている可能性があります。

公式のチュートリアルと比較して、推奨されている最新のものなにか?は確認したほうがよいでしょう。

とにかく認証する

APIを使うにあたって、ハマりやすいポイントはやはり認証です。

なのでまずは認証をすることだけを考えて、実装します。

認証するチュートリアルがあれば、それを参考に。

ない(発見できない)なら送るパラメータが、少なそうなもの、パーミッションがいらなそうなものを探して、そのドキュメントを読みます。

公開されているユーザー情報を取得する。

GETメソッドでパラメータを指定する必要がない(少ない)

これらのものがあれば、まずは認証をしましょう

エラーと仲良くする

スッと認証できればよいのですが、そんなわけもなくハマるのがAPIです。

認証できなければあと頼りになるのはエラーの文章です。

エラーをそのままコピーして、調べてみましょう。

解決策がでてきたら試してみましょう。

質問する、問い合わせる

わからないものはわからないので質問してみましょう。

そのAPIを提供しているコミュニティサイトや公式サイトの問い合わせから問い合わせてみましょう。

実際に使っている人がいればその人に聞いてみるのも手です。

寝る

寝ましょう

今何時ですか?

ずっとパソコンの前にいませんか?

今の体調はどうですか?

疲れていると初歩的なことも見をとしがちです。

一旦寝て明日また考えてみましょう。質問の回答も来ているかもしれません。

認証が通ったら。

認証が通ったら、APIを使えたも同然です!

公式ドキュメントを読みつつ、好きなエンドポイントを扱っていきましょう。

【番外編】gitHubで検索

APIのエンドポイントで検索すると、 gitHubeにソースコードが出てきます。

実際に動いているコードなので、読み解ければ動かせるはずです 中にはGASののファイルも見つかることも。

なくても大抵の場合はJavascriptで書かれたファイルはみつかるはずです。