Nicer Package Manager

    harmony-connect-client

    1.0.8 • Public • Published

    npm version

    Factom Harmony Connect - Node.js Client Library

    This is an automatically generated Node.js client library for Factom Harmony Connect.

    Connect is the fastest way to add blockchain capabilities to your app without cryptocurrencies, wallets, or network nodes. Create an account to get your free API key for the sandbox environment.

    • API version: 1.0.17
    • Package version: 1.0.7
    • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

    For more information, you can view the Connect documentation at https://docs.harmony.factom.com

    Installation

    For Node.js

    npm

    You can install this package via:

    npm install harmony-connect-client --save

    Local development

    To use the library locally without using a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

    npm install

    Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

    npm link

    Finally, switch to the directory you want to use your harmony-connect-client from, and run:

    npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

    You should now be able to require('harmony-connect-client') in javascript files from the directory you ran the last command above from.

    git

    To install the package via the git repository:

        npm install FactomProject/factom-harmony-connect-node-client --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 HarmonyConnectClient = require('harmony-connect-client');
     
    var defaultClient = HarmonyConnectClient.ApiClient.instance;
     
    // Configure API key authorization: AppId
    var AppId = defaultClient.authentications['AppId'];
    AppId.apiKey = "YOUR API KEY"
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //AppId.apiKeyPrefix['app_id'] = "Token"
     
    // Configure API key authorization: AppKey
    var AppKey = defaultClient.authentications['AppKey'];
    AppKey.apiKey = "YOUR API KEY"
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //AppKey.apiKeyPrefix['app_key'] = "Token"
     
    var api = new HarmonyConnectClient.ChainsApi()
    var chainId = 285904; // {String} Chain identifier
     
    var callback = function(error, data, response) {
      if (error) {
        console.error(error);
      } else {
        console.log('API called successfully. Returned data: ' + data);
      }
    };
    api.getChainByID(chainId, callback);
     

    Documentation for API Endpoints

    All URIs are relative to https://connect-shared-sandbox-2445582615332.production.gw.apicast.io/v1

    Class Method HTTP request Description
    HarmonyConnectClient.ChainsApi getChainByID GET /chains/{chain_id} Get Chain Info
    HarmonyConnectClient.ChainsApi getChains GET /chains Get All Chains
    HarmonyConnectClient.ChainsApi postChain POST /chains Create a Chain
    HarmonyConnectClient.ChainsApi postChainSearch POST /chains/search Search Chains
    HarmonyConnectClient.EntriesApi getEntriesByChainID GET /chains/{chain_id}/entries Get Chain's Entries
    HarmonyConnectClient.EntriesApi getEntryByHash GET /chains/{chain_id}/entries/{entry_hash} Get Entry Info
    HarmonyConnectClient.EntriesApi getFirstEntry GET /chains/{chain_id}/entries/first Get Chain's First Entry
    HarmonyConnectClient.EntriesApi getLastEntry GET /chains/{chain_id}/entries/last Get Chain's Last Entry
    HarmonyConnectClient.EntriesApi postEntriesSearch POST /chains/{chain_id}/entries/search Search Chain's Entries
    HarmonyConnectClient.EntriesApi postEntryToChainID POST /chains/{chain_id}/entries Create an Entry
    HarmonyConnectClient.InfoApi getApiInfo GET / API Info

    Documentation for Models

    Documentation for Authorization

    AppId

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

    AppKey

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

    Support

    For more information, you can view the Connect documentation at https://docs.harmony.factom.com

    For additional support, contact us at harmony-support@factom.com

    Keywords

    none

    Install

    npm i harmony-connect-client

    DownloadsWeekly Downloads

    6

    Version

    1.0.8

    License

    MIT

    Unpacked Size

    252 kB

    Total Files

    90

    Last publish

    Collaborators

    • dkmfactom
    • factomdev