TrelloのAPIを実行してみました!
手始めに、「APIを実行する」ということを試してみました!
まずは
まずはTrelloにログインします。
そして「https://trello.com/1/appKey/generate」にアクセス!
こんなのが出てくるので、同意にチェックして、「APIキーを生成ボタン」を押す。
で、出てきたAPIキーをメモっておきます。
同じURLにアクセスすると、次からはAPIキーを表示している画面にそのまま飛ぶようになります。
下の方に出るOauthで使うSecretもメモしておく。
今回はまだ使わないけど。
キー下の説明文にある、『手動で「トークン」を生成できます』のリンクを選択します。
ここで出てくるTokenの値をメモです。
ここで取得した(メモった)、キーとトークンを使って、APIを実行していきます。
TrelloのAPIについて
TrelloのAPIは、ベースとなるURLが
https://trello.com/1/
で、この後ろに「対象のAPI」や「渡す値」を設定することで実行していきます。
他のWeb APIと同じようなもんですね。
TrelloのAPIリファレンスはやさしい!
APIについての詳細は、コチラのリファレンスから参照できます。
Trelloのリファレンスの素晴らしいところは、サンプルが
- cURL
- Node
- Ruby
- javascript
- Python
と、多言語で提示されているところですね。
ユーザに優しい!
APIを叩いてみる
さてAPIを実行していきましょう!
今回はサンプルとして、「ボード一覧を取得」をしていきます。
事前に必要な情報
事前に必要な情報は
- Key(最初にメモしたキー)
- Token(これも最初にメモしたトークン)
- ユーザID(自分のIDを確認しよう!)
の3つです。
APIのURLを作る
「ボード一覧の取得に必要なAPI」の詳細については、「/boards/{id}」を参照してください。
この3つをそれぞれ組込んで、リクエスト用のURLを作成します。
https://trello.com/1/members/<ユーザID>/boards?key=<Key>&token=<Token>&fields=name
それぞれ
- <ユーザID>
- <Key>
- <Token>
を入れてURLを作って実行しましょう。
今回はPythonで実行していこうと思います。こんな感じ。
import requests userId = "ユーザID" key = "Key" token = "Token" url = "https://trello.com/1/members/" + userId + "/boards?key=" + key + "&token=" + token + "&fields=name" response = requests.request("GET", url) print(response.text)
「requests」のインポートで怒られた方は、「pip install requests」とかして導入しましょう。
ちなみに「fields」は、表示するものを絞るのに使うようです。
欲しい情報がある場合は、別途設定してください。
API実行結果
APIを叩くとこんな感じで、ボード名とIDの要素を持った配列が返ってきます。
そのままだと見づらいので、JSONは整形してあります。
[ { "name": "Trelloのテスト", "id": "5a8055221a94672xxxxxxxxx" }, { "name": "Trelloへようこそ/テスト", "id": "5a8054ef24613baxxxxxxxxx" }, (中略) { "name": "テスト", "id": "5becd1072f9d546xxxxxxxxx" } ]
ちゃんと「ボード名」と「ID」の一覧が返ってきましたね!
参考
こちらを参考にしました。ありがとうございました!
あとがき
ということで、TrelloのAPIの叩き方でした。
想像以上に簡単にことが済んでしまいました。
requestsが優秀すぎるだな。