概要

    NAVER WORKS Developers では、NAVER WORKS のデータにアクセスし制御するための API と技術ドキュメントを提供しています。
    NAVER WORKS Bot Platform API 利用に必要な設定は、Developer Console で行います。Community では、開発中に不明な点を質問したり、他社の担当者とノウハウを共有できます。また、お知らせ で API のアップデート情報などを確認できます。

    Developer Console

    Developer Console では、API 利用に必要な以下の基本設定を行います。

    • API 利用に必要な設定や認証情報の提供
      • API ID の発行及び管理
      • Service API Consumer Key の発行及び管理
      • Server API Consumer Key の発行及び管理
      • Server List の登録及び管理
    • SSO Type 設定
    • SAML Apps (NAVER WORKS ID で他サービスにログイン)

      参考
      シングルサインオン (SSO) 設定には、 SSO と SAML Apps の 2 項目があります。 SSO は、NAVER WORKS を Service Provider (SP) とし、外部の統合認証基盤サービスなどのアカウント情報を用いて NAVER WORKS にログインする場合に利用します。
      SAML Apps は、NAVER WORKS を Identity Provider (IdP) とし、NAVER WORKS のアカウント情報で他のクラウドサービスにログインする場合に利用します。SAML Apps では、様々なクラウドサービスに利用可能な統合ログイン機能を提供します。(詳細を見る)

    • 組織連動の利用設定
    • API 統計
    • IPT(IP Telephony) 連動設定
    • トーク Bot の作成及び管理

      参考
      Bot は、NAVER WORKS Bot Platform API または Developer Console のメニューから登録します。メンバーへのメッセージ送受信は API を通じて行います。

    Developer Console は誰が利用できますか？

    Developer Console の利用には、管理画面から以下のいずれかの権限を付与する必要があります。

    • 最高管理者
    • 副管理者
    • カスタム権限の「Developers」が含まれた管理者
      • カスタム権限は、最高管理者または副管理者が NAVER WORKS 管理画面で作成できます。ヘルプを見る

    API を用いて管理作業を行う場合には、最高管理者と同水準のメンバー管理権限が付与されます。Developers 利用権限の管理は慎重に行ってください。

    参考
    Developer Console への初回ログイン時、API 利用規約への同意が必要です。 パートナー経由で NAVER WORKS を契約している場合は、Admin > Partner から Developer Console へのアクセスを許可することで、パートナーも Developer Console にアクセスできるようになります。

    NAVER WORKS Bot Platform API を利用して、様々なシステム連携や業務ツールを実装できます。 NAVER WORKS Bot Platform API を使った開発については、NAVER WORKS Developers の Document の説明と活用ガイド、及びサンプルコードをご参照ください。
    NAVER WORKS Bot Platform API には、サーバー API とサービス API の 2 種類があります。

    • サーバー API: ドメインに関する設定やメンバー情報等を操作するための API です。サーバー API は、Developer Console で API ID, Server API Consumer Key, Server Token または Server ID を発行して利用します。API ID と Server API Consumer Key は必須パラメータで、Server Token と Server ID はいずれかひとつを選択して使用します。
    • サービス API: メンバー自身の Access Token を使って各自のデータ(メール、カレンダー、Drive)にアクセスするための API です。他メンバーのデータにはアクセスできません。サービス API は、Developer Console で API ID と Service API Consumer Key を発行して利用します。

    NAVER WORKS Bot Platform API では以下が提供されます。

    • 組織連動: 役職、職級、利用権限タイプなどを含むメンバー情報や組織情報の設定など
    • メール: メールの送信、削除、作成画面(ポップアップ表示)など
    • トーク Bot: トーク Bot を利用して各ユーザーとメッセージの送受信
    • アドレス帳: マイアドレス帳および共有アドレス帳の登録、参照、削除など
    • カレンダー: 予定の作成、参照、削除、修正、カレンダー作成など
    • ホーム : 掲示板の作成、投稿、削除など
    • Drive: Drive へのファイルのコピー、移動、削除、修正、フォルダ作成など
    • Admin: 管理者画面のタイムゾーン、言語設定、SSO 設定/参照、接続 IP 設定の管理など
    • IPT 連携: IP　電話ソリューション(IP Telephony Solution) と連携し、NAVER WORKS のメンバー情報から IP 電話への発信
    • 監査：監査ログのダウンロードなど

    プランごとの API 提供範囲

    ご利用の製品プランによって利用できるAPIの範囲が異なります。

    Free Lite Basic Premium
    SSO連動 X ◯ ◯ ◯
    組織連携 X ◯ ◯ ◯
    メール X X ◯ ◯
    トークBot ◯
    (最大10個)    		 ◯
    (最大300個)    		 ◯
    (最大300個)    		 ◯
    (最大300個)
    アドレス帳 X ◯ ◯ ◯
    カレンダー X ◯
    (タスクを除く)    		 ◯ ◯
    Drive X X ◯ ◯
    ホーム X ◯ ◯ ◯
    管理者画面 X ◯ ◯ ◯
    IPT X ◯ ◯ ◯
    監査 X ◯ ◯ ◯