LOCAL LLC

KV Store

💡 TL; DR

無料で使える外部KeyValueストレージ

# 追加
curl -X POST https://api.local-llc.com/kvs/add -d '{"key": "キー名", "value": "値"}' -H 'Content-Type: application/json'
## 追加例)
curl -X POST https://api.local-llc.com/kvs/add -d '{"key": "test", "value": "test_value"}' -H 'Content-Type: application/json'
## 出力: {"success":true,"key":"test","value":"test_value"}

# 取得
curl -X GET https://api.local-llc.com/kvs/キー名
## 取得例)
curl -X GET https://api.local-llc.com/kvs/test
## 出力: {"success":true,"key":"test","value":"test_value"}

認証機能を付けることも可能

📍 これは何？

Key-Value型の外部ストレージです。

インターフェイスはすべてJSONで、詳しくは #API定義 をご覧ください。

一時的にデータを保存したい場合にご使用ください。

「ちょっとしたデータを保存したいがWebベースのデータベースを実装するほどでも無い」という用途に使用できます。

注)

  • 社内で使用しているものを公開しているだけのものです。
  • 予告なく仕様変更することがありますが、基本的に後方互換は残します。
  • 有料化の予定はありません。
  • 想定外の使われ方をされるなどした場合など、当社の判断でこれらは予告なく変更されます。


🧮 API定義

1. データ登録 (Create, Update)

  • エンドポイント: https://api.local-llc.com/kvs/add
  • 必須ヘッダー: Content-Type: application/json
  • Body

    • 通常のデータ登録: {"key": "キー名", "value": "値"}

      curl -X POST https://api.local-llc.com/kvs/add \
  -H 'Content-Type: application/json' \
  -d '{"key": "test", "value": "test_value"}'

    • 認証つきデータ登録: {"key": "キー名", "value": "値", "password": "パスワード"}

      curl -X POST https://api.local-llc.com/kvs/add \
  -H 'Content-Type: application/json' \
  -d '{"key": "test", "value": "test_value", "password": "YOUR_PASSWORD"}'
  • その他仕様
    • 新規作成・更新は同一APIです。
    • すでに値が存在した場合、既存の値は上書きされます（これを避けるには認証を掛けてください）。
  • 認証の仕様
    • 認証を掛けている場合、
      • 認証を掛けたときと同一のパスワードを提供しない限り、更新されません。
      • 認証を掛けたときと同一のパスワードを提供しない限り、取得もできません。

[^1] 認証時のパスワードはBcryptにて暗号化されますので、お問い合わせいただいてもお知らせできません。

2. データ取得 (Read)

  • エンドポイント: https://api.local-llc.com/kvs/キー名
  • Body

    • 通常のデータ取得: キー名を指定

      curl https://api.local-llc.com/kvs/test

    • 認証つきデータ取得: キー名を指定した上でクエリパラメータにpasswordを指定

      curl https://api.local-llc.com/kvs/test?password=qwe
  • その他仕様
    • レスポンスはJSONとして解釈されます（Content-Type: application/json ヘッダが付与されます）。

3. データ削除 (Delete)

  • エンドポイント: https://api.local-llc.com/kvs/delete
  • Body

    • 通常のデータ削除: {"key": "キー名"}

      curl https://api.local-llc.com/kvs/delete
  -H 'Content-Type: application/json' \
  -d '{"key": "test"}'

    • 認証つきデータ削除: {"key": "キー名", "password": "パスワードを指定"}

      curl https://api.local-llc.com/kvs/delete
  -H 'Content-Type: application/json' \
  -d '{"key": "test", "password": "YOUR_PASSWORD"}'

📝 利用規約

本APIを利用した時点で本利用規約に同意したものと見なします。ご使用前にご確認ください。

利用規約