Partner API

注意

• Partner API は、顧客管理を行うパートナー様が利用できる API です。
• 通常のテナントではご利用いただけません。
• Partner API (提供終了予定) に記載の API は、将来の提供終了を予定しています。
  • 提供終了予定の API と、それぞれの API の移行先については、各 API のページをご確認ください。

Partner API では、Partner Console 上で行うパートナーと契約する顧客企業のテナント情報を管理できます。
参考 : Partner Console 概要

User Account 認証または Service Account 認証 (JWT) で取得した Access Token で利用できます。

Scope: partner, partner.read

顧客企業の登録 {#register-customer}

顧客企業を登録するには、大きく分けて 2 種類の登録フローがあります。

• 新規に LINE WORKSプラットフォームの利用を開始する顧客企業
  • 今回パートナーとの契約によって新規に LINE WORKSプラットフォームの利用を開始する顧客企業。
  • → 顧客企業の新規登録
• すでに LINE WORKSプラットフォームを利用している顧客企業
  • LINE WORKS のウェブページから既にサービスを利用している顧客企業。
  • → Online Direct 顧客の取り込み

■ 顧客企業の新規登録 {#register-new-customer}

パートナーとの契約によって新規に LINE WORKSプラットフォームの利用を開始する顧客企業を登録します。

参考: Partner Console Guide > 顧客企業の新規登録

ドメイン・グループ名の検証 {#verify-domain}

使用したいドメインまたはグループ名が利用可能か、以下の API で確認します。

顧客企業の登録 {#register-customer}

顧客企業を登録します。

顧客企業情報の新規登録は以下の API で行います。

*.by-works.com または *.by-works.net 以外のドメインを利用する場合には、DNS への登録情報を確認し、DNS の設定後にドメインの所有権確認 (顧客企業の有効化) が必要です。 以下の API で行います。

参考

• DNS の設定について: https://help.worksmobile.com/jp/administrator/registration/verify-domain/how-to-verify-domain/

注意

• LINE WORKSアドバンストプランでメールサービスを利用する場合には、顧客会社の管理者画面で MX レコードの連動確認を行います。
  • 参考: https://help.worksmobile.com/jp/administrator/registration/mx-record/

■ Online Direct 顧客の取り込み {#potential-customer}

すでに LINE WORKSプラットフォームを利用している顧客企業 (= Online Direct 顧客) を、パートナーの管理する顧客として取り込みます。

参考: Partner Console Guide > Online Direct顧客の取り込み

Online Direct 顧客の取り込みは、以下の API で行います。

顧客企業の管理 {#manage-customers}

顧客企業情報 {#manage-customer}

登録済みの顧客企業情報は以下の API で管理します。

顧客企業の使用状況情報 {#usage-status}

顧客企業の使用状況情報の取得、最大ユーザー数の設定、解約予約は以下の API で管理します。

顧客企業の最大ユーザー数設定の予約は以下の API で管理します。

注意

• 顧客企業の最大ユーザー数設定の予約状況は、使用状況の取得 で確認します。

グループからドメインへの変更 {#change-to-domain}

グループからドメインに変更します。
LINE WORKSアドバンストプラン (トライアルを含む) を利用する場合には、あらかじめドメインを利用するよう変更する必要があります。

使用したいドメインが利用可能か、以下の API で確認します。

*.by-works.com または *.by-works.net 以外のドメインを利用する場合は、事前にアップグレードドメインを登録します。

ドメインの登録には以下の API を利用します。

登録後は、DNS の設定を行います。

ドメイン名への変更には以下の API を利用します。

参考

• DNS の設定について: https://help.worksmobile.com/jp/administrator/registration/verify-domain/how-to-verify-domain/

注意

• LINE WORKSアドバンストプランでメールサービスを利用する場合には、顧客会社の管理者画面で MX レコードの連動確認を行います。
  • 参考: https://help.worksmobile.com/jp/administrator/registration/mx-record/

商品の確認 {#manage-subscriptions}

顧客が利用中の商品の確認は以下の API で行います。

商品の契約内容の更新 {#subscriptions-update}

商品の契約内容を変更します。

適用方法について {#subscriptions-update-method}

商品契約の変更の適用には 4 種類あります。

• 即時適用
• 申し込み予約
• 予約適用
• 契約更新時に適用

即時適用 {#realtime-subscription-update}

変更をすぐに適用します。

即時適用できる内容は以下の通りです。

• 商品の利用開始
• 商品の正式利用 (有料転換)
• プランのアップグレード
• ライセンス数の追加
• 商品識別コードとメモの管理
• 商品解約

利用する API は後述の各変更内容ごとの説明を参照ください。

申し込み予約 {#subscriptions-preorder}

利用開始日を指定して、有料商品の申込みを予約することができます。
フリープランとトライアル商品は、即時申し込みを行う必要があります。

変更予約適用 {#subscriptions-update-reservation}

以下の変更について、適用日を指定して変更予約を登録することができます。

• 正式利用 (有料転換)
• ライセンス数の追加
• 商品解約

以下の API を利用します。

商品の変更予約は以下の API を利用します。

※ オプション商品の変更予約設定に利用する API は ■ オプション商品の設定 の説明を参照ください。

契約更新時に適用 {#subscriptions-update-at-renewal}

商品契約の次回の更新時に変更を適用します。

参考: Partner Console Guide > 更新内容の変更

契約更新時に適用できる内容は以下の通りです。

• プランのアップグレード
• ライセンス数の変更
• 契約タイプの変更

以下の API を利用します。

■ 商品の変更 {#change-subscription}

利用商品を変更します。

利用商品の変更には 3 種類あります。

• 利用開始
  • 商品を利用開始します。
    ‐ 即時適用の他、有料商品では申込み予約ができます。
• 正式利用 (有料転換)
  • フリープランまたはトライアル中の商品を、有料商品に切り替えます。
  • 即時適用・予約適用が可能です。
  • 参考: Partner Console Guide > 正式利用(有料利用)への切り替え
• プランのアップグレード
  • 利用中の商品を上位のプランにアップグレードします。
  • 即時適用または契約更新時の適用が可能です。
  • 参考: Partner Console Guide > プランのアップグレード

利用開始 {#add-subscriptions}

商品の利用開始は以下の API を利用します。

申し込み予約を行う場合は、申し込み予約 の説明を参照してください。

正式利用 (有料転換) {#paid-service}

フリープランまたはトライアルプランの商品の有料商品への切り替え (即時適用) は、以下の API を利用します。

予約適用する場合は、予約適用 の説明を参照ください。

プランのアップグレード {#plan-upgrade}

利用中の商品のアップグレード (即時適用) は、以下の API を利用します。

契約の更新時に適用する場合は、契約更新時に適用 の説明を参照ください。

■ ライセンス数 {#change-license-count}

商品のライセンス数を変更します。

参考: Partner Console Guide > ライセンス数と最大ユーザー数の変更

• ライセンス数の変更
  • 商品と契約タイプの組み合わせにより、ライセンス数の指定が必要になります。
  • ライセンス数の追加は、即時・予約適用および契約更新時の適用が可能です。
  • ライセンス数の削減は、契約更新時にのみ適用が可能です。

注意
最大ユーザー数の変更については、顧客企業の使用状況情報 を確認してください。

ライセンス数の変更 {#add-license-count}

商品のライセンス追加 (即時適用) は、以下の API を利用します。

ライセンス数の追加を予約適用する場合は、予約適用 の説明を参照ください。
また、ライセンス数の追加/削減を契約の更新時に適用する場合は、契約更新時に適用 の説明を参照ください。

■ 商品識別コードとメモの管理 {#manage-subscription-memos}

商品識別コードとメモの管理 (即時適用) は、以下の API を利用します。

■ 商品解約 {#cancel-subscriptions}

商品の解約 (即時適用) は API で行います。

■ オプション商品の設定 {#option-products}

オプション商品の設定をします。

参考: Partner Console Guide > オプションの設定

オプション商品の取得・追加・削除 (即時適用)・アップグレード・数量追加・有料転換をする場合は、以下の API を利用します。

予約適用する場合は以下の API を利用します。

オプション商品のダウングレードや数量削除は、オプション商品の更新時に行います。

オプション商品の利用状況は以下の API で参照します。

■ 解約 {#cancellation}

LINE WORKSプラットフォームの解約処理をします。

参考: Partner Console Guide > LINE WORKSの解約処理

解約 (即時適用) には、以下の API を利用します。

LINE WORKSプラットフォームの解約の予約は、使用状況情報の部分更新 を利用します。

請求書・利用履歴の確認 {#history}

請求書や利用履歴を確認します。

参考: Partner Console Guide > 請求書・日別利用履歴の確認

以下の API を利用します。

Appendix {#appendix}

商品グループ ID {#productgroupid}

商品 ID {#productid}

LINE WORKSサービス商品 ID

LINE WORKSラジャーサービス商品 ID

LINE WORKS AiNoteサービス商品 ID

LINE WORKS PaperOnサービス商品 ID

LINE WORKS AiStudioサービス商品 ID

契約タイプ (プラン) {#plan}

オプション商品 {#optionProduct}

LINE WORKSサービスで利用できるオプション商品 {#optionproduct_for_works}

LINE WORKS AiNoteサービスで利用できるオプション商品 {#optionproduct_for_ainote}

LINE WORKS PaperOnサービスで利用できるオプション商品 {#optionproduct_for_paperon}

LINE WORKS AiStudioサービスで利用できるオプション商品 {#optionproduct_for_aistudio}