Trello の REST API を使用する

Trello API は、Trello のリソースにアクセスするための RESTful Web API です。この API を使用して、ボード、カード、メンバーから情報を取得したり、コンテンツを作成、更新、削除したりできます。

Trello の API を使用するメリット

Trello の API は次の目的で使用できます。

• RESTful API リクエストを実行して Trello データにアクセスする

• カスタム スクリプトを書いて、Trello と他のシステムとの間でデータを送信する

• Trello と他のアプリ (CRM など) との間で情報を共有する

• ユーザーに代わって特定のアクションを実行するカスタム Power-Up を作成する

API に関する用語

API の使用を開始する前に、API に関する用語をいくつか紹介します。

API キーとトークンを生成する

Trello の API を使用するには API キーが必要です。API キーを生成するには、まず Trello Power-Up を作成する必要があります。Trello の API にアクセスするには Power-Up を作成する必要があります。Power-Up は API キーの生成プロセスと結びついており、認証プロセス中にキーを識別できるためです。初めての Power-Up を作成する方法については、こちらのガイドをご覧ください。

Power-Up を作成したら、次の手順で API トークン生成します。

1. https://trello.com/power-ups/admin ページにアクセスします。

2. Power-Up をクリックしてから [API キー] タブをクリックします。

3. API キーの右側の段落の末尾にある [トークン] リンクをクリックして、認証ページに進みます。

トークンにアカウントへのアクセスを許可する

トークン認証ページでは以下を確認できます。

• トークンがアクセスできるアカウント

• 実行できること (スコープとも呼ばれる)

トークンは無効にするまで有効で、今後アクセス権を取得するすべてのボードとワークスペースにアクセスできます。

トークンでは以下を実行できます。

• 名前とユーザー名を読み取る

• ユーザー本人としてコメントする

• メール アドレスを読み取る

• Enterprise を読み取る

• Enterprise を更新および管理する

• すべてのボードとワークスペースを読み取る

• カード、リスト、ボード、ワークスペースを作成および更新する

• 所有している Power-Up を読む

• 所有している Power-Up を更新する

このトークンでは次のことができなくなります。

• Trello のパスワードを見る

[許可] をクリックすると、自分のアカウントへの Power-Up アクセスが許可され、API キーとトークンを含むページにリダイレクトされます。

初めての API 呼び出しを実行する

これで、アカウントの API キーとトークンが用意できたので、API 呼び出しを開始できます。

Trello で最も一般的な API 呼び出しの 1 つが、ボードの API エンドポイントです。API 1/members/{memberId}/boards エンドポイントに GET リクエストを実行して、ユーザーに関連付けられているすべてのボードを一覧表示できます。この例では、コンピューターのターミナル アプリケーションで cURL を使用します。

ターミナル アプリケーションを開いて、次のように入力します。

curl 'https://api.trello.com/1/members/me/boards?key={yourKey}&token={yourToken}'

Trello の API を使って API 呼び出しを送信するには、次のような多くの方法があります。

• JavaScript、Python、PHP、Node.JS などのコーディング言語 (Trello の API とやり取りするスクリプトを書く場合)。

• Postman や SoapUI などの API プラットフォーム。これらの API プラットフォームは、API を扱うためのユーザー フレンドリーなインターフェイスを提供します。

どのプラットフォームやコーディング言語がニーズに合っているかは、ご自身で判断できます。

応答を理解する

JSON は人間の代わりにコンピューターが読むように設計されているので、フォーマットされていない長いテキスト ブロックのように見えます。必要に応じて、後からテキスト エディターやその他のツールを使って、JSON を読みやすいようにフォーマットできます。とりあえず、最初のボード ID を見つけます。

最初のボード ID を見つける方法。

1. 最初のリクエストを入力した場所までスクロールして戻ります

2. リクエストの直後に、次のような形式の 24 文字の ID が表示されます: [{"id":"xxxxxxxxxxxxxxxxxxxxxxxx",

3. 引用符の中の ID をコピーします

最初の呼び出しの情報を使用して別の API 呼び出しを実行する

レスポンスに記載されている情報により、特定のボードの 1 つからより多くの情報を得ることができます。

2 回目の API 呼び出しを行う方法。

1. JSON レスポンスからボード ID の 1 つをコピーします

2. 次の API 呼び出しの {idBoard} テキストをボード ID に置き換えます:

curl 'https://api.trello.com/1/boards/{idBoard}?key={yourKey}&token={yourToken}'

レスポンスには、その ID のボードに関する情報が含まれます。たとえば、ボードの名前と説明はレスポンスの冒頭にあります。

ここに挙げたのは Trello API を使い始める方法のほんの一例に過ぎず、ここからたくさんの可能性を探ることができます。Trello API の機能について詳しく知るには、Trello API のドキュメントをご覧ください。

その他の API 呼び出しの例

• ワークスペースのボードをすべて取得: curl 'https://api.trello.com/1/members/me/organizations/{organizationId}/boards

• ボードのカードをすべて取得: curl 'https://api.trello.com/1/boards/{boardId}/cards?key=APIKey&token=APIToken

• Trello Enterprise のユーザーをすべて取得: curl 'https://api.trello.com/1/enterprises/{enterpriseId}/members/query?key=APIKey&token=APIToken

カスタム スクリプトやユーザー生成の開発に対するサポートは提供されていませんが、開発者の活発なコミュニティをご利用いただけます。Trello の API の使用に興味を持っていただきありがとうございます。Trello の開発者コミュニティで指導とサポートを求めることを強くお勧めします。

その他のリソース

• Trello の API ドキュメント

• API の詳しい紹介

• Trello 開発者コミュニティ