1.0.0 • Published 4 years ago

pip-clients-creditcards-node v1.0.0

Weekly downloads
3
License
MIT
Repository
github
Last release
4 years ago

Credit Cards Microservice Client SDK for Node.js

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

Quick Links:

Install

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

{
    ...
    "dependencies": {
        ....
        "pip-clients-creditcards-node": "^2.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-creditcards-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.CreditCardsHttpClientV1(config);

// Connect to the microservice
client.open(null, 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

// Create a new credit_card
var credit_card = {
    customer_id: '1',
    type: 'visa',
    number: '1111111111111111',
    expire_month: 1,
    expire_year: 2021,
    first_name: 'Bill',
    last_name: 'Gates',
    billing_address: {
        line1: '2345 Swan Rd',
        city: 'Tucson',
        zip: '85710',
        country_code: 'US'
    },
    cvc: '213',
    name: 'Test Card 1',
    saved: true,
    default: true,
    state: 'ok'
};

client.createCreditCard(
    null,
    credit_card,
    function (err, credit_card) {
        ...
    }
);
// Get the list of credit_cards on 'time management' topic
client.getCreditCards(
    null,
    {
        customer_id: '1',
        state: 'ok'
    },
    {
        total: true,
        skip: 0,
        take: 10
    },
    function(err, page) {
    ...    
});

Acknowledgements

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