タスクワールド(Taskworld)ブログ

とにかく使いやすい!実際の業務で重宝する機能が満載!

タグ:連携

〜世界基準プロ管ツール タスワーの可能性を更に広げるAPIの記事をご紹介!〜

これまでにご紹介してきた「タスクワールドAPI連携」に関する記事を一覧にまとめました。
(更新日:2018年10月10日 午後12時)

「この様な視点、このようなニーズに対応をしたタスクワールドAPI連携に関してのヒント記事に興味がある!」という方は、タスクワールド公式サイトより、気軽にお問い合わせください!

API

★API連携

APIでタスクワールドが更に便利に!GAS botのサンプルプログラム!!

タスクワールドAPI、Javascript サンプルプログラムを使ってみましょう!

Javaや PHPで、タスクワールドをもっと便利に!

イッキに解説します!タスクワールド APIの使い方!

--------------

タスクワールドは、15日間無料でトライアル利用が可能です。
トライアル期間中は、アナリティクス機能を含む、そのすべての機能を無制限で使えます。
日本語によるサポートもバッチリなので、ぜひ気軽にトライアルスタートを!

twbanner_700x230_ja

1-cR7Xny-Rt1dGa1JGiexWBw

1-LXIE6IOdez6aMNcva6C6Bg

〜Google Apps Script で タスクワールドのチャットに通知する bot を作りましょう!〜

API


今回は Google Apps Script(以下GAS)を使用して、タスクリストの期限切れタスクの件数をチャットに通知する bot を作成します。

このサンプルでは Google とタスクワールドのアカウントが必要になります。また、タスクワールド API で使用する ID も用意しておきましょう。ID はタスクワールド画面の「アカウント設定 > データのダウンロード」からダウンロードするか、または<前回記事>のサンプルソースで取得できます。


スクリプトを作成

まずはGoogle Apps Script プロジェクト一覧画面で新規スクリプトを作成し、スクリプトエディタを開きます。

このエディタ上にサンプルスクリプトをコピーペーストして保存します。プロジェクト名・ファイル名は任意で構いません。

editor



プロパティを登録

次にアクセストークンと ID をスクリプトプロパティに登録します。

メニューの「ファイル > プロジェクトのプロパティ」から「スクリプトのプロパティ」を開き、以下のようにプロパティを追加します。

properties


スクリプトの実行を承認

ここまで準備したら動作確認を行いましょう。myFunction 関数を選択してメニューバーのデバッグボタン(虫のマーク)をクリックします。

debug


すると、最初に実行する時は「承認が必要です」というメッセージが出てきます。

「許可を確認」をクリックし、次の「アカウントの選択」フォームで使用アカウントをクリックします。この後、許可ボタンが表示されれば許可に進みますが、「このアプリは確認されていません」と表示されたら「プロジェクト名(安全ではないページ)に移動」をクリックし、メッセージに従って進んでください。

permission


承認が完了するとスクリプトが実行されます。

タスクワールドのチャットに以下のようなメッセージが表示されたら成功です!

message



スケジュールを設定

スクリプトを定期的に実行したい場合は、GAS でトリガーを登録しましょう。

スクリプトエディタのメニューから「編集 > 現在のプロジェクトのトリガー」でフォームを開き、トリガーを追加して任意のタイミングを設定します。下図の場合、毎週月曜の午後に myFunction 関数を実行します。

trigger



スクリプトの実装内容

スクリプトに実装した処理内容を簡単にご説明します。

最初に実行する myFunction 関数は、期限切れタスクの件数を数えてメッセージを送信するメイン処理です。

func1MyFunc


myFunction からラッパー関数を呼び出してタスクリストの取得およびメッセージの送信を行います。また、スクリプトプロパティにアクセスし、各 API で送信するパラメータを用意します。

func2Wrapper


postRequest 関数はタスクワールド API の呼び出しを実行します。

func3Apicall



まとめ

今回はさらに実践的な内容となりましたが、いかがでしたか?

GAS を使うとスクリプトの実行環境や定期処理が無料で利用できてとても便利ですね。また、GAS からデータをスプレッドシートに記録したり、他のサービスへ連携するハブにも使えます。

プロジェクト管理は何かと大変ですが、API を活用して便利な環境を作っていきたいですね!

--------------

タスクワールドは、15日間無料でトライアル利用が可能です。
トライアル期間中は、アナリティクス機能を含む、そのすべての機能を無制限で使えます。
日本語によるサポートもバッチリなので、ぜひ気軽にトライアルスタートを!

twbanner_700x230_ja

1-cR7Xny-Rt1dGa1JGiexWBw

1-LXIE6IOdez6aMNcva6C6Bg

〜API連携により、タスクワールドの可能性が大幅に広がります!〜

API


今回は Taskworld API で情報を取得する Javascript のサンプルプログラムをご紹介します。こちらは認証ユーザーに紐づく情報を取得してワークスペース内の情報をツリー状に表示しますので、登録情報のご確認や仕様理解のご参考にお使いいただけます。

本稿ではプログラムの使い方と実装のポイントをご説明します。


サンプルプログラムの使い方

まずはサンプルの使い方をご説明します。こちらのファイルを PC にダウンロードして解凍して下さい。

※本記事の公開時点ではセキュリティ上の理由から API サーバ側で CORS 制限を掛けています。そのため本プログラムをWEB サーバーから直接配信する場合は情報取得時にクロスドメインエラーが発生しますのでご注意ください。

htmlファイルをブラウザで開くと以下のように表示されますので、email と password 欄に登録済みユーザーの認証情報を入力して「情報取得」ボタンをクリックします。

tool01

認証情報を間違えると以下のように result 欄にエラー情報が表示されます。この場合は再入力してリトライしてください。

tool02_autherr

認証に成功すると以下のようにユーザー情報とワークスペース情報が表示されます。

tool03_authok

「ユーザー情報」には認証したユーザーの登録情報とアクセストークン、デフォルトスペース ID(ユーザー登録時最初に作成したワークスペース)が表示されます。

「ワークスペース情報」には、ユーザーが参加しているワークスペースの一覧が表示されます。(default)となっているのは認証したユーザーのデフォルトスペースです。

ワークスペース名がASCII文字以外の場合、ワークスペース名はハッシュコードの形になります。これはプロジェクト ID とは違うので注意してください。

※なお、こちらは記事公開時点の仕様であり、今後変更される可能性があります。

ワークスペース名をクリックすると、アコーディオンが展開してワークススペースの詳細を表示します。

tool04_workspace

丸括弧でくくった数字は下位のアイテムの件数です。

「channels」「projects」のアイテムをクリックすると各々の詳細を表示します。

「channels」はチャットの情報です。

「general / project channel(s)」 はそれぞれワークスペースとプロジェクトのデフォルトのチャットです。

「group channels 」は任意で作成したグループチャット、「direct channels 」はダイレクトメッセージです。チャット情報を展開すると以下のようになります。

tool05_channels

「project(s)」はプロジェクトの情報です。アコーディオンを展開するとプロジェクトの詳細とタスクリストが表示されます。タスクリストとタスクはさらにクリックして詳細を表示できるようになっています。

tool06_projects



以上がサンプルプログラムの使い方です。


実装のポイント

このプログラムの実装のポイントとしては、階層化された情報を順番に取得するための仕組みを設けた点がまず挙げられます。タスクワールドのオブジェクトの情報を取得するには上位オブジェクトの ID を指定する必要があるため、必然的にこのようなスタイルになります。

また、一度にすべての関連情報を取得すると大量の通信が発生するため、本プログラムではアコーディオン表示を展開した時に追加情報を取得しています。

イベントごとに行う処理は以下の通りです。

★「情報取得」ボタン押下時
・auth(ユーザー認証)
・user.get-info(認証ユーザーのユーザー情報を取得)
・workspace.get-user(ユーザー名表示のためワークスペースのユーザー情報を取得)
・workspace.get-all(ワークスペースの情報を取得)
・channel.get-all(各ワークスペースのチャット情報を取得)

★ワークスペース表示展開時
・project.get-all(プロジェクト情報取得)
・tag.get-all(タブ名表示のためタグ情報を取得)

★プロジェクト表示展開時
・tasklist.get-all(タスクリスト取得)

★タスクリスト表示展開時
・tasklist.get-tasks(タスク情報取得)



本プログラムでは各アイテムを識別しやすくするために、ユーザーやタグについては登録名も表示しています。ですが、以下の情報は記事公開時点ではAPIから取得できませんので、こちらはタスクワールド管理画面で確認していただく必要があります。

・日本語のワークスペース名
・プロジェクトチャットのプロジェクト名



まとめ

いかがでしたか?今回は情報取得のみでしたが、更新や追加の API を組み合わせれば自由なデザインでタスクワールドを操作できるようになります。興味がある方はぜひトライしてみてくださいね。


--------------

タスクワールドは、15日間無料でトライアル利用が可能です。
トライアル期間中は、アナリティクス機能を含む、そのすべての機能を無制限で使えます。
日本語によるサポートもバッチリなので、ぜひ気軽にトライアルスタートを!

twbanner_700x230_ja

1-cR7Xny-Rt1dGa1JGiexWBw

1-LXIE6IOdez6aMNcva6C6Bg

〜API連携により、タスクワールドの可能性が大幅に広がります!〜

今回は Taskworld API でタスクを登録するサンプルプログラムをご紹介します。

Javascript(jQuery)と PHP で、フロント/サーバそれぞれからリクエストを送信する場合のサンプルです。

API

それでは、Let's スタート!

※API のリファレンスはこちらの、アジアサーバー向けのドキュメントを参照してください。
https://asia-api.taskworld.com/#introduction

前回の記事「イッキに解説します!タスクワールド APIの使い方!」もご参照ください。

------

Javascript で Taskworld API を呼び出してみよう!

まずは Javascript です。

以下のようなフォーム画面からタスクワールドにタスクを登録するプログラムを見てみましょう。

js02_view

1. ソースコード

サンプルソースはこちらです。

ajax 関数で リクエストを送信して、画面に結果を表示するだけのシンプルな内容です。

js01_source

2. 認証キー・IDを用意

タスク登録には以下のパラメータが必要になります。タスクワールドのデータを確認しておきましょう。それぞれの取得方法は前回の記事を参考にしてください。

・認証キー
・スペースID
・プロジェクトID
・リストID


ソースに各パラメータを定義したら、ファイルを .html 形式で任意の場所に保存します。

このファイルをWebブラウザで開くと先ほどのフォームが表示されます。

3. API 呼び出しを実行

それでは API 呼び出しを実行してみましょう。

下のようにフォームのテキスト欄にタスク名を入力してボタンを押すと、ajax 通信で非同期リクエストが送信されます。

js03_view

result 欄に「OK」と表示されたら処理成功です。

タスクワールドのプロジェクトを表示すると、以下のようにタスクが追加されていることが確認できますね。

js04_tw

なお、API でタスクを作成する際は、タスク名しか設定ができないのでご注意ください。

期限などを設定するには、別途タスク更新(task.update)を行う必要があります。


PHP で Taskworld API を呼び出してみよう!

次はサーバから PHP で Taskworld API を呼び出すサンプルです。

今回は、タスク登録の後にタスク更新も実行して、期日などの詳細設定を同時に行ってみましょう。

php00_tw_sample_img


1. ソースコード

PHP のサンプルソースはこちらになります。

2. POST リクエストの送信方法

今回は POST リクエストを2回実行するので、送信処理を関数化しています。

関数ではリクエストボディを送信するために stream_context_create でストリームコンテキストを作成し、file_get_contents を実行します。

コンテキストオプションの詳しい説明はこちらを参照してください。

もしパフォーマンスなどが気になる場合は、file_get_contents の代わりに curl を使用すると良いでしょう。

php01_postfunc


3. 認証キー・IDを用意

タスク登録に必要なパラメータを用意します。それぞれの取得方法は前回の記事を参考にしてください。

・認証キー
・スペースID
・プロジェクトID
・リストID


用意したパラメータをプログラムで以下のように定義します。

新しく登録するタスクの名前は引数で受け取るようにしましょう。

php02_api_defs


4. タスクの登録・更新

タスク登録とタスク更新の実装は以下のようになります。

下図の上部「①タスク登録」がタスク登録を実行するブロックです。先ほど作成した POST 送信関数に URL、APIコマンド名、パラメータを渡していますね。

登録時はコマンドに "task.create" を指定します。

php03_api_calls

タスク登録に続き、タスク更新の実装です。

図の「②タスク更新」のブロックで、タスク ID と以下の詳細情報をクエリパラメーターに設定しています。コマンドには ”task.update” を指定します。

・タスク ID(直前に実行した登録リクエストのレスポンスから取得)
・タスクのポイント数
・タスクの色
・説明
・タスクの開始日(=現在時刻を設定)
・タスクの期日(=1週間後を設定)

5. API 呼び出しを実行

PHP の実行環境にソースファイルを配置して、コンソールから実行してみましょう。
下図のように実行時引数でタスク名を渡すと、その名前でタスクが登録されます。


php04_console


タスクワールド上でタスクリストを確認すると、リアルタイムでタスクが登録されます。

php05_tw_add_task

赤枠で囲んだ箇所は task.update で更新した部分です。期日などの設定が確認できますね。


タスクワールドをもっと便利に!

今回ご紹介した処理を応用することにより、外部システム上での作業進捗を、タスクワールドと連携することができ、プロジェクト管理における利便性が大幅に向上します。

例えば Wordpress の場合を考えてみましょう。

下書きを投稿した時にタスクを登録するプラグインを作成すれば、スタッフの誰かが記事を作成する度にタスクが追加されて、タスクワールド上で未公開記事の状況が確認できるようになります。

煩雑なプロジェクト管理を自動化/一元化できると助かりますよね。

ぜひ、お使いのシステムで Taskworld API を活用してみてください!

--------------

タスクワールドは、15日間無料でトライアル利用が可能です。
トライアル期間中は、アナリティクス機能を含む、そのすべての機能を無制限で使えます。
日本語によるサポートもバッチリなので、ぜひ気軽にトライアルスタートを!
twbanner_700x230_ja

1-cR7Xny-Rt1dGa1JGiexWBw

1-LXIE6IOdez6aMNcva6C6Bg

〜API連携により、タスクワールドの可能性が大幅に広がります!〜

「Taskworld API」 はタスクワールドのリソースにアクセスできる JSON ベースの Web APIです。様々なクライアントから実行可能で、タスクワールドのユーザーであれば、機能に制限なく、誰でも利用することが可能です。

API


本日は、「Taskworld API」の使い方サンプルを駆け足で見ていきましょう!

Let's スタート!

※API のリファレンスはこちらの、アジアサーバー向けのドキュメントを参照してください。
https://asia-api.taskworld.com/#introduction

------

まずは認証キーの取得からスタート!

クラウドサーバーによるタスクワールドのサービスは、アジア、欧米、欧州の3つの異なるリージョンで運営がされています。サインアップ時に選択したサーバーのリージョンがアジアであれば、アカウントおよびワークスペースは、アジアのサーバーで運営されているということになります。

利用しているサーバーのリージョンをチェックしてみましょう。タスクワールドのワークスペースにアクセスをして、そのURL のドメインが「asia-enterprise.taskworld.com」となっていれば、アジアのサーバーが使われていることが確認できます。

01_01_region

アジアリージョンの API に認証リクエストを送信して、認証トークンを取得してみましょう。

本記事では、 HTTP クライアントに Chrome専用アプリ「Postman」を使用します。Postmanの詳細に関しては、その公式サイトを参照してください。

Postmanを起動し、リクエストメソッド / API の URL / MIMEタイプを設定します。

01_02_postman_auth_1

続いて、 Bodyタブを開き、「raw / JSON」を選択して、登録情報のJSON(メールアドレス、パスワード)を入力します。

01_03_postman_auth_2

「Send」ボタンでリクエストを送信すると、下段に結果が表示されます。

今回はリクエストが成功し、レスポンスで以下の認証情報を取得できました:

・access_token(認証トークン)
・default_space_id(ユーザーが最初に作成したワークスペース)
・workspaces(ユーザーがアクセス可能なワークスペース)


「access_token」は、この先すべての API で使用します。その使用に際して制限などは設けられていないため、取り扱いには十分注意をしてください。

01_04_postman_auth_res

下は、メールアドレスが誤りの場合のエラーレスポンスです。

01_05_postman_auth_err

エラーに関しては、 API リファレンスのエラー情報を参照して下さい。


ワークスペースのデータ構成はこうなっています!

それではここで、ワークスペースを構成するオブジェクトの関係を少しだけ見てみましょう。

下図は、APIが返却するオブジェクトの概念的な関連図です。

02_01_er

タスク管理の基本構成は、ワークスペース > プロジェクト > タスクリスト > タスクという親子関係になっています。

チャンネル(チャット)はユーザー/ワークスペース/プロジェクトに紐づいており、各々のチャンネルの会話がメッセージとして保存されます。

メッセージは、この他にタスクコメントとして単独でも使用されます。そのため、メッセージは 「parent_id」 と 「parent_type(channel / task)」の2種類のキーで親オブジェクトを識別している点に注意してください。

これらの登録データは、APIで取得する他に、一括でダウンロードすることも可能です。一括ダウンロードは、タスクワールドのアカウント設定画面からリクエストを送信できます。

JSON

※ダウンロードデータの型は、APIレスポンスとは若干異なります。

ワークスペースのデータ量が多いと、APIだけで構成を把握するのは大変です。あらかじめデータをダウンロードしておけば、開発がスムーズに進むのでオススメです。

それでは、実際にAPIを使ってみましょう!


APIで、ワークスペース情報を取得!

まずはワークスペースの情報を取得します。

「Get workspaces API」 で、ユーザーがアクセス可能な全てのワークスペースの情報を取得しましょう。ここからは、前述の取得済み「access_token」を認証に使用します。

03_01_workspace_all


「Get workspaces API」では、ワークスペースの「name」に注意してください。

「Taskworld API v1」 では、URL に使用するキー文字列(日本語の名前の場合はハッシュ値)が「name」として返ります。そのためレスポンスを見ただけでは、どれがどのワークスペースなのか区別するのが難しい時があります。

前述のデータダウンロードであれば、日本語名も取得できるので、可能であれば両者を突き合わせてレスポンスを確認する事をオススメします。


APIで、タスクリスト&タスクを追加!

次は、APIを使い、プロジェクトにタスクリストを追加してみましょう。

「Create a tasklist API」を使用します。ワークスペース、プロジェクト、そして追加するタスクリスト名を指定して実行します。

03_02_add_tasklist


リクエストが成功したら、タスクワールド上での表示を確認しましょう。下のスクリーンショットのように、タスクリストがリアルタイムで追加されます。

03_03_added_tasklist

追加したタスクリストに、タスクを作成してみましょう。「Create a task API」で、先ほどのレスポンスの「list_id」を指定し、タスク名を設定します。

03_04_add_task

先ほどのタスクリストと同様、下のスクリーンショットのように、リアルタイムでタスクが追加されます。

03_05_added_task



APIで、タスクを更新!

それでは、APIにより、作成済みのタスクを更新してみましょう。

「Update a task API」で、タスクにポイント、ラベル色、タスク説明テキスト、開始日・期日を追加してみます。

※「API v1」では、日時をグリニッジ標準時で指定します。

更新に成功すると、レスポンスで更新後のタスクオブジェクトが返ってきます。

03_06_update_task


下のスクリーンショットのように、リアルタイムでタスクワールドのワークスペース上に、タスクの詳細情報が追加・更新されます。

03_07_updated_task


APIではこの他に、タグやメッセージの操作、タスクの移動なども行えます。

ぜひ色々と試してみてください!


Slack bot を作ってみましょう!

サンプルソースを使用して、タスクワールドの特定のタスクリストを操作する、“Slack App” を作成してみましょう。

このサンプルでは、ローカル環境の node で稼働するタスクワールド操作コマンドを、「ngrok」 経由で公開して「Slack(スラック)」と連携させます。

1. localhost 環境構築

まずは、ローカル環境を構築します。

実行環境は ubuntu16.04 / node.js v9.11.2 です。

サンプルソースを API リファレンス「Examples」の github リポジトリリンクから取得しましょう。

ソースを使いやすい場所に展開したら、「tw-slack-bot」ディレクトリへ移動して、関連モジュールをインストールし、node を起動します。

この段階では起動確認だけできれば良いので .env は port だけ設定しておきましょう。

$ cd tw-slack-bot
$ yarn init # 設定値はデフォルトでOK
$ npm install --save-dev
$ cp .env.sample .env
$ vi .env # とりあえず port だけ設定
$ node index.js


続いて、「ngrok」 をインストールして localhost を公開します。

「ngrok」 に関しては、こちらのSlack のチュートリアルも参考にしてみてください。

04_00_ngrok


2. Slack Appの作成とインストール

Slack Appを作成しましょう。作成方法はSlack 公式サイトでも公開されているので、ここでは、 slash command の追加手順だけ見てみましょう。

ブラウザで Slack にログインして、Slack App 構築ページを開き、「Create a slack app」を選択します。

04_01_slackapp_create

作成ウィンドウが開くので、 Slack Appの任意の名前と、 開発対象のSlack ワークスペースを指定します。

04_02_slackapp_create2

「Basic Information」 が開いたら、「Slash Command」をクリックします。次の画面では、「Create New Command」に進みましょう。

04_03_slackcmd_1

「Create New Command」 画面に移動したら、次のようにコマンド設定を入力します。

・Command: /twctask
・Request URL: https://[ngrok で割り当てられたドメイン名]/twctask


その他は任意で設定し、「Save」をクリックします。

04_05_slackcmd_3

作成したコマンドをSlack のワークスペースにインストールします。

「Install App」画面では、「Install App to Workspace」をクリックして、次の画面で「Authorize」へ進むとインストールが完了します。

04_06_install



3. localhost のコマンド設定

最後に、ローカルのソースを編集してコマンドが正しく動作するように設定しましょう。

サンプルソースは北米サーバー向けになっているので、「tw-slack-bot/taskworld.js」の API URL をアジア用に修正します。

04_10_code


前述のステップで、「port」 を設定した 「.env」 に、今度は Slack と Taskworld API の設定を追加します。

Slack の情報はこの3つです。

・CLIENT_ID
・CLIENT_SECRET
・VERIFICATION_TOKEN


Slack の情報は「App Credentials」で確認します。

Slack のコマンド管理画面を開いて下の方にスクロールすると「App Credentials」の欄があるので、そこから必要事項をコピーして .env に記述します。

04_11_credential


タスクワールドの情報は4件です。操作対象のタスクリストに関する情報と、認証トークンを記述しましょう。

・ACCESS_TOKEN: Auth API で取得した access_token
・SPACE_ID - ID: ワークスペース ID
・PROJECT_ID: プロジェクト ID
・LIST_ID: 対象のタスクリスト


.env を更新したら node を再起動します。


4. コマンドを実行する

作成したコマンドをSlack から実行してみましょう。

04_12_cmd_exe

そうすると、下のスクリーンショットのように、タスクワールド上でタスクが新たに追加されます。

04_13_result


この他にも、Taskworld APIを活用することにより、サンプルをベースにして様々な機能を作り込んでいくことが可能です。

ぜひ色々と試してみてください!


--------------

タスクワールドは、15日間無料でトライアル利用が可能です。
トライアル期間中は、アナリティクス機能を含む、そのすべての機能を無制限で使えます。
日本語によるサポートもバッチリなので、ぜひ気軽にトライアルスタートを!
twbanner_700x230_ja

1-cR7Xny-Rt1dGa1JGiexWBw

1-LXIE6IOdez6aMNcva6C6Bg

↑このページのトップヘ