開発環境
LINE Planetでは、テスト用(evaluation)と本番用(real)の2つの環境を提供します。作業環境によってplanet_base_urlが異なるため、必ず正しいサーバーアドレスを使用しなければなりません。
| 環境 | 用途 | planet_base_url |
|---|---|---|
| Evaluation | 開発段階やPoC(Proof of Concept)を実施する際に、LINE Planetを連携して短時間内にテストできる環境です。 | https://voipnx-saturn.line-apps-rc.com |
| Real | サービスの運用段階、または運用サービスのQA段階のように実際の環境でテストを実施する場合に使用します。 | https://voipnx-saturn.line-apps.com |
API keyとLINE Planetの環境
LINE Planetを連携する前に、API keyを生成する必要があります。API keyを生成するためには、以下の4つの情報が必要です。
| 項目 | 情報 | 必須 |
|---|---|---|
| LINE Planetの環境 | Evaluation、realのうち使用する環境 | 必須 |
| サービスID | 文字列形式のサービス識別子 | 必須 |
| アプリケーションサーバーのコールバックURL | LINE Planetサーバーが呼び出すアプリケーションのコールバックURL。全部で3つのコールバックが必要です。
| 必須 |
| ウェブアプリケーションのドメイン | ウェブアプリケーションのドメインアドレス。LINE Planet Cloudにおいて、CORS(Cross-Origin Resource Sharing)ポリシーに従ってクライアントのオリジン(origin)を許可するためには、ウェブアプリケーションのドメインを事前に知っておく必要があります。 | 任意(WebPlanetKitを使用する場合のみ) |
Note
サービスID形式のルールについては、サービスIDを参照してください。
サンプル
ここでは、作業の手順を理解するための例を示します。この例では、アプリケーションの環境を、開発/RC/本番環境で構成していますが、このような構成では以下の点に注意が必要です。
- 環境ごとのAPI keyを生成する
- API keyと
planet_base_urlを正しく紐付けて使用する
1. 3つのAPI keyの生成
以下のように、開発環境およびRC環境、本番環境で利用する3つのAPI keyを生成します。
| アプリケーション環境 | API keyの生成データ | 生成したAPI key |
|---|---|---|
| 開発環境 | 1 環境:Evaluation 2 サービスID:planet-ex-service-dev 3.1 notify_cb:http://dev.app.com/call/notify 3.2 on_call_evt_cb:http://dev.app.com/call/endevt 3.3 on_gcall_evt_cb:http://dev.app.com/call/gcall | API-EVAL-1 |
| RC環境 | 1 環境:Real 2 サービスID:planet-ex-service-rc 3.1 notify_cb:http://rc.app.com/call/notify 3.2 on_call_evt_cb:http://rc.app.com/call/endevt 3.3 on_gcall_evt_cb:http://rc.app.com/call/gcall | API-REAL-1 |
| 本番環境 | 1 環境:Real 2 サービスID:planet-ex-service-real 3.1 notify_cb:http://real.app.com/call/notify 3.2 on_call_evt_cb:http://real.app.com/call/endevt 3.3 on_gcall_evt_cb:http://real.app.com/call/gcall | API-REAL-2 |
2. クライアント設定:API keyとplanet_base_urlの紐付け
アプリケーションでPlanetKit SDKを初期化する際に、上記の生成で取得したAPI keyと、それぞれのAPI keyに紐付くplanet_base_urlを使用しなければなりません。この例では、環境ごとに以下のように設定します。
| アプリケーション環境 | 生成したAPI key | planet_base_url |
|---|---|---|
| 開発環境 | API-EVAL-1 | Evaluation(https://voipnx-saturn.line-apps-rc.com) |
| RC環境 | API-REAL-1 | Real(https://voipnx-saturn.line-apps.com) |
| 本番環境 | API-REAL-2 | Real(https://voipnx-saturn.line-apps.com) |
Note
WebPlanetKitの場合、環境ごとにライブラリファイルが異なります。そのため、初期化時にplanet_base_urlの設定は不要です。