認証

Realtime API

Private Channel の購読には認証が必要です。
API ページにおいて発行した API Key と API Secret を使用します。「注文のイベントを受信」という権限が必要です。
API key をご利用いただけるのは、bitFlyer Lightning をご利用可能なお客様のみとなります。

各接続方法の auth メソッドにて認証要求が可能です。

🚧

認証完了またはエラーのレスポンスを必ず確認してから次の動作を実行してください。

認証要求パラメーター

下記のプロパティは全て必須です。

PropertyTypeDescription
api_keyStringAPI Key
timestampNumberリクエスト時の Unix Timestamp (10 または 13 桁)
nonceStringリクエストごとにランダムな文字列 (16 から 255 文字)
signatureString上記 timestamp + nonce を文字列連結したものを API Secret で HMAC SHA256 署名した Hex (16進数) 文字列

パラメーター作成例

const crypto = require("crypto");

const key = "{{ YOUR API KEY }}";
const secret = "{{ YOUR API SECRET }}";

function getAuthParams() {
    const now = Date.now();
    const nonce = crypto.randomBytes(16).toString("hex");
    const sign = crypto.createHmac("sha256", secret)
                       .update(`${now}${nonce}`).digest("hex");
    return {
        api_key: key,
        timestamp: now,
        nonce: nonce,
        signature: sign
    };
}