Skip to main content

Development environment

LINE Planet provides two development environments: Evaluation (for testing) and Real (for real service). As shown in the table below, planet_base_url varies depending on the development environment, and you must use the correct value as a server address in your application.

EnvironmentUsageplanet_base_url
EvaluationUse this environment to integrate LINE Planet into your application and perform tests during the development stage or PoC (Proof of Concept) in a short time.https://voipnx-saturn.line-apps-rc.com
RealUse this environment for operating a service or for testing in a real environment, such as during the QA phase of a real service.https://voipnx-saturn.line-apps.com

API key and LINE Planet environment

Before integrating LINE Planet into your application, you must generate an API key. To generate an API key, you require the following information:

ItemDescriptionRequired
LINE Planet environmentEvaluation or RealRequired
Service IDString type service identifierRequired
Application server callback URLThe callback URL of the application to be called by the LINE Planet server. A total of three callbacks are required.
  • 1-to-1 call callbacks
    • notify_cb: Called when a new call is made
    • on_call_evt_cb: Called when the call is released
  • Group call (conference) callback
    • on_gcall_evt_cb: Called when a participant joins or leaves
Required
Web application domainThe domain address of the web application. LINE Planet Cloud needs to know the web application domain in advance in order to allow the origin of the requesting client based on the Cross-Origin Resource Sharing (CORS) policy.Optional (Only for WebPlanetKit)
Note

For the allowed format of service ID, refer to Service ID.

Example

Here is an example to understand the workflow. Assume that you have configured your application in three environments: Development, Release Candidate, and Real. In this case, note the following:

  • You must generate an API key for each environment.
  • You must use a proper pair of API key and planet_base_url for each environment.

1. Generate three API keys

Generate three API keys for Development, Release Candidate, and Real.

Application environmentData to generate API keyGenerated API key
Development1 Environment: Evaluation
2 Service 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
Release Candidate1 Environment: Real
2 Service 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
Real1 Environment: Real
2 Service 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. Configure client settings

When initializing PlanetKit SDK in your application, you must use a pair of the obtained API key and the corresponding planet_base_url. In this example, configure as below for each environment.

Application environmentGenerated API keyplanet_base_url
DevelopmentAPI-EVAL-1Evaluation (https://voipnx-saturn.line-apps-rc.com)
Release CandidateAPI-REAL-1Real (https://voipnx-saturn.line-apps.com)
RealAPI-REAL-2Real (https://voipnx-saturn.line-apps.com)
Note

For WebPlanetKit, it is not required to set planet_base_url during the initialization process because the library file for each environment is different.