Partner API (提供終了予定)

注意

• Partner API は、顧客管理を行うパートナー様が利用できる API です。
• 通常のテナントではご利用いただけません。
• Partner API (提供終了予定) に記載の API は、将来の提供終了を予定しています。
  • 提供終了予定の API と、それぞれの API の移行先については、各 API のページをご確認ください。
  • 今後は、Partner API をご利用ください。
• LINE WORKSサービス以外の LINE WORKSファミリー製品を取り扱うパートナー様が Partner 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 で確認します。

顧客企業の登録/管理 {#manage-customer}

顧客企業の登録や参照・編集をします。

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

登録済みの顧客企業情報や契約情報は以下の API で参照します。

また、顧客企業情報の編集は以下の API で行います。

ドメインの所有権確認 {#activate-customer}

Standard でドメインを利用する、または、Advanced で .by-works.com 以外のドメインを利用する場合には、DNS の設定後にドメインの所有権確認が必要です。 以下の API で行います。

参考

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

注意

• MX レコードの連動確認は、管理者画面や Partner Console 上から行ってください。
  • 参考: 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 で行います。

契約内容の変更 {#subscription-update}

顧客企業の契約内容を変更します。

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

契約内容の変更の適用には3種類あります。

• 即時適用
• 予約適用
• 契約更新時に適用

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

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

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

• 正式利用 (有料利用)
• プランのアップグレード
• ライセンス数 (追加のみ)
• 最大ユーザー数
• LINE WORKS サービス及びプラットフォーム解約

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

予約適用 {#subscription-update-reservation}

適用日を指定 (予約) します。

予約適用できる内容は以下の通りです。

• 正式利用 (有料利用)
• ライセンス数 (追加のみ)
• 最大ユーザー数
• オプション商品
• LINE WORKS サービス及びプラットフォーム解約

以下の API を利用します。

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

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

次に契約を更新する際に適用します。

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

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

• プランのアップグレード
• ライセンス数
• 最大ユーザー数
• ドメイン名
• 支払い方法

以下の API を利用します。

■ プランの変更 {#change-plan}

プランを変更します。

プランの変更には2種類あります。

• 正式利用 (有料利用)
  • Free から Standard / Advanced へ切り替える場合 (有料利用) 、または、Standard (Trial) / Advanced (Trial) から Standard / Advanced の正式利用に切り替える場合です。
  • 即時適用・予約適用が可能です。
  • 参考: Partner Console Guide > 正式利用(有料利用)への切り替え
• プランのアップグレード
  • Standard から Advanced 、または、Standard (Trial) から Advanced (Trial) にアップグレードする場合です。
  • 即時適用または契約更新時の適用が可能です。
  • 参考: Partner Console Guide > プランのアップグレード

(Advanced のみ) ドメインの登録 {#upgrade-domain}

Advanced / Advanced (Trial) へアップグレード、かつ、by-works.com 以外のドメインを利用する場合は、事前にドメイン登録をする必要があります。

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

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

参考

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

注意

• MX レコードの連動確認は、管理者画面や Partner Console 上から行ってください。
  • 参考: https://help.worksmobile.com/jp/administrator/registration/mx-record/

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

正式利用 (有料利用) への切り替え (即時適用) は、以下の API を利用します。

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

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

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

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

■ ライセンス数 / 最大ユーザー数の変更 {#change-license-member}

ライセンス数 / 最大ユーザー数を変更します。

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

支払い方法によって2種類のフローがあります。

• ライセンス数の変更
  • 「年額契約 月額後払い / 一括払い」を指定している顧客企業では、ライセンス数の変更となります。
  • ライセンス数の追加は、即時・予約適用および契約更新時の適用が可能です。
  • ライセンス数の削減は、契約更新時にのみ適用が可能です。
• 最大ユーザー数
  • 「月額後払」を指定している顧客企業では、最大ユーザー数の変更となります。
  • 即時・予約適用および契約更新時の適用が可能です。

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

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

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

最大ユーザー数の変更 {#set-max-member-count}

最大ユーザー数の追加 (即時適用) は、以下の API を利用します。

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

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

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

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

オプション商品の追加・編集・削除 (即時適用) する場合は、以下の API を利用します。

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

現在の適用されているオプション商品や利用状況は以下の API で参照します。

■ 解約 {#cancellation}

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

注意
LINE WORKS サービスのみの解約は、Partner Console から行ってください。

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

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

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

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

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

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

以下の API を利用します。

参考 {#reference}

顧客企業・契約内容の登録・変更フロー全体。