Repository files navigation

This is an automatically generated Node.js client library forFactom 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 athttps://docs.harmony.factom.com

You can install this package via:

npm install harmony-connect-client --save

To use the library locally without using a remote npm registry, first install the dependencies by changinginto the directory containingpackage.json (and this README). Let's call thisJAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next,link it globally in npm with the following, also fromJAVASCRIPT_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 torequire('harmony-connect-client') in javascript files from the directory you ran the lastcommand above from.

To install the package via the git repository:

    npm install FactomProject/factom-harmony-connect-node-client --save

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

browserify main.js> bundle.js

Then includebundle.js in the HTML pages.

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

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

Please follow theinstallation instruction and execute the following JS code:

varHarmonyConnectClient=require('harmony-connect-client');vardefaultClient=HarmonyConnectClient.ApiClient.instance;// Configure API key authorization: AppIdvarAppId=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: AppKeyvarAppKey=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"varapi=newHarmonyConnectClient.ChainsApi()varchainId=285904;// {String} Chain identifiervarcallback=function(error,data,response){if(error){console.error(error);}else{console.log('API called successfully. Returned data: '+data);}};api.getChainByID(chainId,callback);

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

• HarmonyConnectClient.AllInfo
• HarmonyConnectClient.AllInfoLinks
• HarmonyConnectClient.Chain
• HarmonyConnectClient.ChainCreate
• HarmonyConnectClient.ChainData
• HarmonyConnectClient.ChainDataDblock
• HarmonyConnectClient.ChainDataEblock
• HarmonyConnectClient.ChainDataEntries
• HarmonyConnectClient.ChainLink
• HarmonyConnectClient.ChainList
• HarmonyConnectClient.ChainListData
• HarmonyConnectClient.ChainShort
• HarmonyConnectClient.Entry
• HarmonyConnectClient.EntryCreate
• HarmonyConnectClient.EntryData
• HarmonyConnectClient.EntryDataDblock
• HarmonyConnectClient.EntryDataEblock
• HarmonyConnectClient.EntryList
• HarmonyConnectClient.EntryListChain
• HarmonyConnectClient.EntryListData
• HarmonyConnectClient.EntrySearchResponse
• HarmonyConnectClient.EntrySearchResponseData
• HarmonyConnectClient.EntryShort
• HarmonyConnectClient.SearchBody

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

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

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

For additional support, contact us atharmony-support@factom.com