pip-clients-accounts-node

User Accounts Microservice Client SDK for Node.js

This is a Node.js client SDK for pip-services-accounts microservice. It provides an easy to use abstraction over communication protocols:

• HTTP/REST client
• GRPC client
• Direct client for monolytic deployments
• Null client to be used in testing

Quick Links:

• Development Guide
• API Version 1

Install

Add dependency to the client SDK into package.json file of your project

{
    ...
    "dependencies": {
        ....
        "pip-clients-accounts-node": "^1.0.*",
        ...
    }
}

Then install the dependency using npm tool

# Install new dependencies
npm install

# Update already installed dependencies
npm update

Use

Inside your code get the reference to the client SDK

var sdk = new require('pip-clients-accounts-node');

Define client configuration parameters that match configuration of the microservice external API

// Client configuration
var config = {
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};

Instantiate the client and open connection to the microservice

// Create the client instance
var client = sdk.AccountsHttpClientV1(config);

// Connect to the microservice
client.open(function(err) {
    if (err) {
        console.error('Connection to the microservice failed');
        console.error(err);
        return;
    }
    
    // Work with the microservice
    ...
});

Now the client is ready to perform operations

// Register a new account
client.createAccount(
    null,
    { 
        name: 'Test User',
        login: '[e-mail]'
    },
    function (err, account) {
        ...
    }
);

// Find created account
client.getAccountByLogin(
    null,
    '[e-mail]',
    function(err, account) {
    ...    
    }
);

Acknowledgements

This client SDK was created and currently maintained by Sergey Seroukhov.