Circular Documentation
  • Getting Started
  • Introduction
    • Introducing Circular
  • Circular's Mission
  • Circular's Technology
    • Certificates & Data Anchoring
    • Multi-Chain Architecture
    • Certified Nodes & Jurisdictional Deployment
    • HyperCode & GPU Accelerated Processing
    • Proof of Reputation Consensus Mechanism
  • Certified Intelligence
  • Developer Tools
    • Enterprise APIs
      • Javascript
        • CEP_Account.open()
        • CEP_Account.setNetwork()
        • CEP_Account.setBlockchain()
        • CEP_Account.update()
        • CEP_Account.submitCertificate()
        • CEP_Account.getTransactionOutcome()
        • CEP_Account.getTransaction()
        • CEP_Account.close()
      • Node.JS
        • CEP_Account.open()
        • CEP_Account.setNetwork()
        • CEP_Account.setBlockchain()
        • CEP_Account.update()
        • CEP_Account.submitCertificate()
        • CEP_Account.getTransactionOutcome()
        • CEP_Account.getTransaction()
        • CEP_Account.close()
      • PHP
        • CEP_Account.open()
        • CEP_Account.setNetwork()
        • CEP_Account.setBlockchain()
        • CEP_Account.updateAccount()
        • CEP_Account.submitCertificate()
        • CEP_Account.getTransactionOutcome()
        • CEP_Account.getTransaction()
        • CEP_Account.close()
      • Python
        • CEP_Account.open()
        • CEP_Account.set_network()
        • CEP_Account.set_blockchain()
        • CEP_Account.update_account()
        • CEP_Account.submit_certificate()
        • CEP_Account.get_transaction_outcome()
        • CEP_Account.get_transaction()
        • CEP_Account.close()
      • Java
        • CEP_Account.open()
        • CEP_Account.setNetwork()
        • CEP_Account.setBlockchain()
        • CEP_Account.updateAccount()
        • CEP_Account.submitCertificate()
        • CEP_Account.getTransactionOutcome()
        • CEP_Account.getTransaction()
        • CEP_Account.close()
  • SDK
  • CLI & Tooling
  • Core Concepts
    • Overview
    • Certificates
  • Accounts
  • Private Chains
  • Data Management
  • Fees
  • Nodes
  • Private Keys
  • Recovery Phrases
  • Tutorials & Examples
    • Circular Connect Guide
      • Create an Organisation Account
      • Create a Blockchain Account
      • Purchase Certificates
      • Using the Explorer & Viewing Certificate Details
    • Create Your First Certificate
  • Industry Use Cases
    • Industry Use Cases - Overview
    • Clinical Trials
    • Medical Devices
    • Public Health
    • Pharma Supply Chains
    • Research and Academia
Powered by GitBook
On this page
  • Overview
  • Installation
  • Usage
  • Example (CommonJS)
  • Example (ES Modules)
  • Useful Links
  1. Developer Tools
  2. Enterprise APIs

Node.JS

Overview

The Circular Enterprise APIs provide a powerful and efficient way to certify data on the blockchain, ensuring immutability, transparency, and security. These APIs facilitate account management, network configuration, data signing, and transaction monitoring, making it easier for enterprises to integrate blockchain-based certification into their workflows.

This library is designed for developers who need to verify, sign, and submit data certificates using the Circular blockchain while maintaining seamless integration with Node.js applications.

Installation

You can install the Circular Enterprise APIs via npm:

npm install circular-enterprise-apis

Usage

The API supports both CommonJS and ES Modules, allowing for easy integration into different JavaScript environments.

Example (CommonJS)

const { CEP_Account } = require('circular-enterprise-apis');

const Address = 'your-wallet-address';
const PrivateKey = 'your-private-key';
const blockchain = '0x8a20baa40c45dc5055aeb26197c203e576ef389d9acb171bd62da11dc5ad72b2';
let account = new CEP_Account();
async function run() {
account.open(Address);
await account.updateAccount();
const submitResult = await account.submitCertificate("Enterprise API Test", PrivateKey);
if (submitResult.Result === 200) {
    console.log("Certificate submitted:", submitResult);
} else {
    console.log("Submission failed:", submitResult.message);
}

account.close();
}
run();

Example (ES Modules)

import { CEP_Account } from 'circular-enterprise-apis';

const Address = 'your-wallet-address';
const PrivateKey = 'your-private-key';

let account = new CEP_Account();

async function run() {
    account.open(Address);
    await account.updateAccount();
    const submitResult = await account.submitCertificate("Enterprise API Test", PrivateKey);

    if (submitResult.Result === 200) {
        console.log("Certificate submitted:", submitResult);
    } else {
        console.log("Submission failed:", submitResult.message);
    }

    account.close();
}

run();

Useful Links

PreviousCEP_Account.close()NextCEP_Account.open()

Last updated 10 days ago

You can find more on the or on the .

official GitHub repository
official NPM repository