Giter Club home page Giter Club logo

originstamp-client-javascript's Introduction

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

[email protected]

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.