なでしこ3簡単保存API(nako3kvs)

これは、日本語プログラミング言語「なでしこ3」のためのWeb APIです。ブラウザ上で動くなでしこのプログラムから、データをサーバーに保存するためのWeb APIです。

どうして必要なの?

そもそも、ブラウザ上で動く「なでしこ3」で、サーバーにデータを保存するためには、自分でサーバーを持っており、データの保存APIを自分で作らなくてはなりません。これは、それなりにハードルが高いものです。しかし、この簡単保存API(nako3kvs/なでしこ3Key-Value-Store)を使えば、手軽にサーバーにデータを保存できます。

利用用途は?

例えば、ゲームのハイスコアや、メッセージボードの作成、ちょっとしたユーザーデータの保存などに使えます。

想定する利用用途

  • ゲームのハイスコア記録
  • メッセージボード
  • アクセスカウンターなどのカウンター

使い方

この機能を使うと、ブラウザの「なでしこ3」から、サーバーにデータを保存できます。例えば、「test」というキーに「hoge」という値を記録したとします。すると、いつでも「test」というキーを使って「hoge」という値を取得することができます。

保存できるのは文字列のみですですが、JSONエンコード、JSONデコードを使えば、複雑なデータも保存可能になります。

なお、nako3kvsは次の手順で利用します。

(1)キーを作成する

最初に、自分が使いたいキーを作成しましょう。キーの作成は、こちらの管理画面から行ってください。
いくつでも作成できます。キーの作成にはパスワードが必要です。このパスワードは閲覧・変更に必要なので忘れないようにしましょう。

(2) キーの取得

以下のようにして指定のキーをサーバーより取得できます。(ただし、なでしこ3簡易エディタは「取り込む」をサポートしていません。テストは、なでしこ3貯蔵庫をご利用ください。)

  1行目    v3.3.74

(3) 値の変更

以下のように『KVS設定』命令を利用して値を変更できます。以下の例では毎回異なる値を書き込みます。

  1行目    v3.3.74

ライブラリを使わないAPIのアクセス方法

キーの閲覧

以下のGETリクエストを送信するとデータを閲覧できます。

[URL]
https://nadesiko.net/nako3kvs/api.php?mode=get&key=(キー名)&password=(パスワード)

キーの変更

以下のGETリクエストを送信するとデータを変更できます。

[URL]
https://nadesiko.net/nako3kvs/api.php?mode=set&key=(キー名)&value=(新しい値)&password=(パスワード)&time=(更新日時UNIXTIMEミリ秒)
  • timeパラメータは省略可能です。指定する場合、更新日時のUNIXTIMEをミリ秒で指定します。注意点としてtimeが既存の値より古い場合更新されません。
    • なでしこでtimeを使うには「システム時間」を1000倍するか、3.2.31以降で使える「システム時間ミリ秒」を使います。

更新履歴

  • 2022/05/12 --- なでしこ3ライブラリをアップデート。手軽に使えるように。
  • 2021/12/25 --- timeパラメータを追加して簡単な排他ロックを追加。
  • 2021/12/20 --- nako3kvsのサービスを開始。

メモ