Introduction

    LINE WORKSとの連携アプリを開発するためのLINE WORKS API 2.0 に関するドキュメントです。

    アプリ開発者はLINE WORKS API 2.0 を利用して、Botの利用、組織やグループの管理、ファイルのアップロード/ダウンロードなど、LINE WORKSが提供する様々な機能やリソースをAPIで利用可能です。

    API利用の準備

    LINE WORKS API 2.0 を利用する手順は、下記の通り。

    1. 「LINE WORKS管理者画面 > セキュリティ > 管理者権限」でアプリ開発者にDevelopers権限を付与（参考）

      注意
      Developers権限の付与が反映されるためには一定の時間がかかります。必ず事前に行ってください。

    2. Developers権限を持つアカウントでログインし、「Developers Console」を開く

    3. アプリを新規追加する
    4. アプリで利用するAPIのscopeを選択する
    5. アプリでOAuth認証の後、Access Tokenを発行する
    6. Access TokenをもとにAPIをコールする

    APIのRequestまたはResponse BodyのデータフォーマットはJSON(JavaScript Object Notation)を利用します。JSONの詳細については、こちらを参照してください。

    APIの利用

    LINE WORKS API 2.0 が提供するすべてのAPIは、RESTful形式で、HTTPSを経由してEnd Pointに接続します。
    End Point URLは 「https://www.worksapis.com/v1.0/」です。
    例としてGETメソッドでBotリストを取得する方法は以下の通りです。

    • GET https://www.worksapis.com/v1.0/bots

      詳細は各APIの説明ページを参照してください。

    新機能、機能改善、および改修を行った場合は、「お知らせ」にてAPIのアップデート情報を公開します。

    APIを活用した開発に関するディスカッションにはCommunityをご利用ください。

    LINE WORKS API 2.0にはサービス安定化のため、一定時間内に実行可能なAPI呼び出し回数を制限する「Rate limit」が設定されています。APIの呼び出し回数がRate Limitを超過すると、一時的に呼び出しが制限されてエラーを返します。詳細は「Rate limits」を参照してください。