動画1-1. APIでタスクを作成する

動画1-1. APIでタスクを作成する

0. はじめに

Bizer teamではサービス外から一部のリソースを操作できるWebAPI(以後、オープンAPI)を提供している。本稿では利用イメージを共有する目的で、オープンAPIを用いたタスク作成を例に、具体的な利用手順について述べる。

1. 利用手順

APIの仕様書はBizer teamオープンAPIドキュメントを参照。

1-1. アクセスキーとシークレットキーの発行

  1. ログイン > 設定 > アクセスキー にアクセス(図1.1)。

    図1.1 アクセスキー画面

    図1.1 アクセスキー画面

    <aside> 💡 ユーザー権限が「管理者」「マスター」のいずれかである必要がある。

    </aside>

  2. アクセスキーを生成ボタンを押下するとモーダルが表示されるので、任意の名前をつけて作成するボタンを押下。

  3. アクセスキーおよびシークレットキーが画面内に表示されるので、任意の方法でメモを取る(図1.2)。なおシークレットキーは、この画面から離れると再表示する方法がない。

    図1.2 生成したアクセスキーおよびシークレットキー

    図1.2 生成したアクセスキーおよびシークレットキー

1-2. グループIDの取得

  1. グループ一覧画面を表示。

  2. 任意のグループ名を押下し、グループ詳細画面を表示(図1.3)。

  3. アドレスバーに表示されているアドレス「https://{code}.bizer.team/groups/{group_id}」のうち、{group_id}がグループIDにあたる。

    図1.3 グループ詳細画面

    図1.3 グループ詳細画面

1-3. リクエストの生成

ここまでの操作により、オープンAPIの利用に必要な情報を取得できた。本節ではそれらの情報を用いて、タスクを作成するリクエストを発行する。

  1. JSONフォーマットにより必要情報をObject化する。下記、サンプル。

    {
      "access_token": "40e34a07-49d6-4c38-bb22-8d79e28d4474",
      "access_token_secret": "902f4b1d-cb88-4c1d-a4b5-f5f827fce95a",
      "issue": {
        "title": "Hello Bizer team",
        "group_id": 11
      }
    }
    
  2. リクエストヘッダーに Content-Type: application/jsonを付与し、POSTリクエストを発行する。下記、CURLコマンドを用いたサンプル。

    $ curl -X POST -H "Content-Type: application/json" -d '{"access_token":"40e34a07-49d6-4c38-bb22-8d79e28d4474","access_token_secret":"902f4b1d-cb88-4c1d-a4b5-f5f827fce95a","issue":{"title":"HelloBizerteam!","group_id":11}}' <https://api.bizer.team/open/api/v1/issues.json>
    
  3. 正常にタスクが生成された場合、次のようなJSONフォーマットのレスポンスボディが返却される。

    {
      "status": 201,
      "issue": {
        "id": 4604,
        "title": "Hello Bizer team",
        "memo": "",
        "assignee_id": 14,
        "assignee_code": "2171235-543c-47e0-a13d-40de89cc5ecb",
        "group_id": 11,
        "group_code": "f8e-UJ0c",
        "code": "Ac9fPQPL",
        "custom_id": null,
        "number": 1685,
        "created_at": "2021-05-17T19:26:31.961+09:00",
        "updated_at": "2021-05-17T19:26:31.961+09:00",
        "finished_at": null,
        "stared": false,
        "repeat": false,
        "status": "未着手"
      }
    }
    
  4. 実際にタスクが作成されていることを確認する。

    図1.4 オープンAPIで作成したタスクの詳細画面

    図1.4 オープンAPIで作成したタスクの詳細画面