Node's Pastoral Musicians

    hirez-signature

    1.0.1 • Public • Published

    hirez-signature

    This project has no affiliation with Hirez studios

    A lightweight 0 dependency signature generator for the Official hirez API, it's essential just a wrapper for the crypto hash object

    Examples

    const createHirezSignature = require('hirez-signature');
    const fetch = require('node-fetch');
     
    async function fetchMethod(methodName, devId, authKey, session) {
      const { signature, timestamp } = await createHirezSignature(devId, methodName, authKey);
      const res = await fetch(`http://api.smitegame.com/smitgame.svc/${methodName}Json/${devId}/${signature}/${session ? `${session}/` : ''}${timestamp}`);
      return await res.json();
    }
     
    async function createSession(devId, authKey) {
      return await fetchMethod('createsession', devId, authKey);
    }

    Documentation

    Functions

    createHirezSignature.createTimestamp()string

    Create a timestamp as defined in hirez API docs

    createHirezSignature(devId, methodName, authKey, [timestamp])Promise.<Object>

    Create a hirez signature

    createHirezSignature.createTimestamp() ⇒ string

    Create a timestamp as defined in hirez API docs

    Kind: global function Returns: string - timestamp

    createHirezSignature(devId, methodName, authKey, [timestamp]) ⇒ Promise.<Object>

    Create a hirez signature

    Kind: global function Returns: Promise.<Object> - A promise that resolves to an object containing signature and timestamp

    Param Type Default Description
    devId string | number Your API devId
    methodName string The name of the api method being called (without type)
    authKey string You API authKey
    [timestamp] string "Current timestamp" (Optional) The timestamp to use

    Install

    npm i hirez-signature

    DownloadsWeekly Downloads

    2

    Version

    1.0.1

    License

    GPL-3.0

    Unpacked Size

    40.4 kB

    Total Files

    6

    Last publish

    Collaborators

    • douile