← にち化

API

使い方

ブラウザのJavaScriptから利用できます。初期値は非可逆です。

import { createClient } from
  'https://nichika.pages.dev/api-client.js';

const api = createClient();
const { result } = await api.nichika('こんにちは');

可逆・復号

const encoded = await api.nichika('ひみつ', {
  mode: 'reversible',
  passphrase: '長く固有のあいことば'
});
const decoded = await api.decode(
  encoded.result, '長く固有のあいことば'
);
const original = decoded.result;
Node.jsで使う

Node.js 22以降のES Modulesで、api-client.js と crypto.js を同じディレクトリに配置します。

import { createClient } from './api-client.js';
const api = createClient({
  baseUrl: 'https://nichika.pages.dev'
});
HTTPで使う

https://nichika.pages.dev に、Content-Type: application/json でPOSTします。本文はSDKの関数で作成してください。

エンドポイント本文を作る関数
/api/v1/nichikaprepareNichika(text, options)
/api/v1/decodeprepareDecode(text, passphrase)
import { prepareNichika } from './api-client.js';
const body = await prepareNichika('こんにちは');

利用条件

入力は最大4,096バイト、あいことばは最大1,024バイトです(UTF-8)。HTTP本文は256 KiB以内です。

可逆・復号では文字列と導出鍵をサーバーへ送信します。非可逆では元の文字列を送信しません。入力・鍵・結果は保存しません。

APIキーが設定された場合のみ、createClient({ apiKey }) または Authorization: Bearer <APIキー> を指定します。キーはサーバー側で管理してください。

失敗時はSDKが例外を返します。HTTPでは error.code と error.message を確認してください。