Japanese Document is here

Overview

This repository stores the REST API server source code used for the Clova extension "Dice Drawer". To see how the "Dice Drawer" extension works, use the voice command "サイコロ遊びを起動して (Launch the dice game)" on the Clova app or any Clova-compatible speaker (such as WAVE or Friends). The extension will tell you the results of the dice roll. You can roll 1-10 dice at a time, and the extension will tell you the sum of all dice if you are rolling 2 or more dice.

Requirements

The REST API server for the "Dice Drawer" Clova extension is implemented using Node.js. Any compatible operating system including Windows, macOS, Linux can run the server. You can find more information on compatibility, and download the latest version of Node.js on the official Node.js website. https://nodejs.org/ja/download/current/

Installation

Follow the steps below to install the "Dice Drawer" REST API server source code.

1. Install Node.js: https://nodejs.org/ja/download/current/
2. Download the source code: git clone https://github.com/line/clova-extension-sample-dice.git
3. Install library dependencies: npm install
4. Edit config.js to replace "com.example.dice" with your Extension ID

Usage

The REST API server for the "Dice Drawer" Clova extension is designed to return appropriate responses to the extension requests sent from the Clova platform. Be advised that even if you run the API server, the API requests must be identical to the requests sent from the Clova platform. When publicly launching the service, you must change the domain to a HTTPS-based domain that can be accessed publicly.

• Run the API server: node app.js
  • To disable the signature verification、run DEBUG=true node app.js
• Test the API server: Using Postman, send the following JSON request to test if a JSON response is returned.
  • URL: http://localhost:3000/clova
  • Request method: POST
  • Body: Select "raw" and then select "JSON (application/json)" from the dropdown menu
• Request example

{
  "version": "0.1.0",
  "session": {
    "sessionId": "55ca6ee4-72dd-4694-b30f-4b49e238634f",
    "user": {
      "userId": "U1bd47e4c7c68ca8a8ead15517d055ad1",
      "accessToken": "3d0e7bab-2c1a-44d4-be20-c84910b78e2c"
    },
    "new": true
  },
  "context": {
    "System": {
      "user": {
        "userId": "U1bd47e4c7c68ca8a8ead15517d055ad1",
        "accessToken": "3d0e7bab-2c1a-44d4-be20-c84910b78e2c"
      },
      "device": {
        "deviceId": "da6db6c26dcbe1a077eb2c890031ce2b1980asf2d30e00ee58804daf0ee89eff"
      },
      "application": {
        "applicationId": "com.example.dice"
      }
    }
  },
  "request": {
    "type": "IntentRequest",
    "intent": {
      "name": "ThrowDiceIntent",
      "slots": {
        "diceCount": {
          "name": "diceCount",
          "value": "1"
        }
      }
    }
  }
}

License

NAVER & LINE Corporation

LICENSE

Copyright 2018 NAVER Corp. & LINE Corporation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.