Nacho Portion Monitor

    originstamp-client-javascript

    2.0.1 • Public • Published

    OriginStamp JavaScript Client

    Build Status

    A JavaScript implementation of the OriginStamp API. For endpoint documentation see OriginStamp Documentation.

    For more information, please visit https://originstamp.com.

    Installation

    npm

    Install it via:

    npm install originstamp-client-javascript --save

    For browser

    The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

    browserify main.js > bundle.js

    Then include bundle.js in the HTML pages.

    Webpack Configuration

    Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

    module: {
      rules: [
        {
          parser: {
            amd: false
          }
        }
      ]
    }

    Getting Started

    Please follow the installation instruction and execute the following JS code:

    var OriginStamp = require('originstamp-client-javascript');
    
    var api = new OriginStamp.APIKeyApi()
    
    var authorization = "authorization_example"; // {String} A valid API key is essential for authorization to handle the request.
    
    
    var callback = function(error, data, response) {
      if (error) {
        console.error(error);
      } else {
        console.log('API called successfully. Returned data: ' + data);
      }
    };
    api.getApiKeyUsage(authorization, callback);

    Documentation for API Endpoints

    All URIs are relative to https://api.originstamp.com

    Class Method HTTP request Description
    OriginStamp.APIKeyApi getApiKeyUsage GET /v3/api_key/usage Usage
    OriginStamp.BulkApi createBulkTimestamp POST /v4/timestamp/bulk/create Bulk Submission
    OriginStamp.BulkApi getSeedStatus GET /v4/timestamp/status/seed/{seed_id} Seed Status
    OriginStamp.ProofApi getProof POST /v3/timestamp/proof/url Proof
    OriginStamp.SchedulerApi getActiveCurrencies GET /v3/currencies/get Get active currencies
    OriginStamp.TimestampApi createTimestamp POST /v4/timestamp/create Submission
    OriginStamp.TimestampApi getHashStatus GET /v4/timestamp/{hash_string} Status
    OriginStamp.TimestampApi getSeedStatus GET /v4/timestamp/status/seed/{seed_id} Seed Status
    OriginStamp.WebhookApi getWebhookStatus POST /v3/webhook/information Webhook
    OriginStamp.WebhookApi registerWebhookNotification POST /v3/webhook/register Webhook
    OriginStamp.WebhookApi triggerTimestampWebhook POST /v3/webhook/start Dev

    Documentation for Models

    Documentation for Authorization

    API Key Authorization

    • Type: API key
    • API key parameter name: Authorization
    • Location: HTTP header

    Author

    mail@originstamp.com

    Keywords

    none

    Install

    npm i originstamp-client-javascript

    DownloadsWeekly Downloads

    12

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    173 kB

    Total Files

    59

    Last publish

    Collaborators

    • pehret
    • dennis-tra-os
    • danmuf