Ocean Codes SDK for Node.js

The Ocean Codes SDK is a tool for Node.js that makes it easy to use Ocean API services like PAN verification and OCR (Optical Character Recognition).

Installation

To install the SDK, run this command in your terminal:

npm install oceancodes-sdk

How to Use

Before using the SDK, you need to initialize it with your clientId and secretKey, which are provided by Invincible Ocean. To obtain these credentials, simply create an account and generate your clientId and secretKey by visiting the Invincible Ocean Dashboard.

const { Apis } = require('oceancodes-sdk');

// Set up the SDK with your clientId and secretKey
const apis = new Apis('yourClientId', 'yourSecretKey');

Available API Methods

1. PAN Verification

You can verify a PAN number using the verifyPan method.

Example:

async function verifyPan() {
    try {
        const result = await apis.verifyPan('ABCDE1234F');  // Replace with the actual PAN number
        console.log('PAN Verification Result:', result);
    } catch (error) {
        console.error('Error during PAN verification:', error.message);
    }
}

verifyPan();

2. Global OCR

Use the globalOcr method to get text from the front and back images of documents.

Example:

async function performOcr() {
    try {
        const frontImagePath = './path/to/front-image.jpg';  // Path to the front image
        const backImagePath = './path/to/back-image.jpg';    // Path to the back image

        const ocrResult = await apis.globalOcr(frontImagePath, backImagePath);
        console.log('OCR Result:', ocrResult);
    } catch (error) {
        console.error('Error during OCR processing:', error.message);
    }
}

performOcr();

Using Environment Variables

You can also set your clientId and secretKey using environment variables. To do this, create a .env file in your project folder with the following details:

CLIENT_ID=yourClientId
SECRET_KEY=yourSecretKey

Then load these values in your code like this:

require('dotenv').config();  // Load environment variables from .env file
const { Apis } = require('oceancodes-sdk');

const apis = new Apis(process.env.CLIENT_ID, process.env.SECRET_KEY);

More Information

For full API documentation, visit: Ocean APIs Documentation.

Need Help?

If you have questions or need help, contact us at:

• Email: [email protected]
• Website: Invincible Ocean Dashboard

License

This SDK is available under the MIT License. For more information, see the LICENSE file.