ADP Connection Library
Description
The ADP Connection library wraps the authorization (oAuth 2.0) connection steps for connecting to ADPs API gateway.
Previous version support
npm install adp-connection@1.1.1
Installation
$ npm install adp-connection
Usage
API Docs & Examples
Create Client Credentials ADP Connection
; const connectionOpts = clientId: '1234567890' clientSecret: 'ABC-DEF-GHI-JKL' granttype: 'client_credentials' sslCertPath: './certs/cert.pem' sslKeyPath: './certs/cert.key';const connectionComplete = { // Use adp-core to do all the things...};const conn = adpConnection;conn;
Create Authorization Code ADP Connection
; const connectionOpts = clientId: '1234567890' clientSecret: 'ABC-DEF-GHI-JKL' granttype: 'authorization_code' sslCertPath: './certs/cert.pem' sslKeyPath: './certs/cert.key' callbackUrl: 'https://myapp.domain.com/callback';const conn = adpConnection; // in an express app...res; // Authorization endpoint will respond to `https://myapp.domain.com/callback` with `code` query parameterconst authorizationCode = reqquerycode; // Set authorizationCode in connection options. connectionOptsauthorizationCode = authorizationCode; // createConnection with authorizationCode set.const conn = adpConnection;const connectionComplete = { // connected ...};conn;
Debug
Enable debugging by setting the NODE_DEBUG
environment variable.
$ export NODE_DEBUG=adp-connection,adp-core
Contributing
To contribute to the library, please generate a pull request. Before generating the pull request, please insure the following:
- Appropriate unit tests have been updated or created.
- Code coverage on unit tests must be no less than 100%.
- Your code updates have been fully tested and linted with no errors.
- Update README and API documentation as appropriate.
Sample Client
A sample client is provided to demonstrate usage of the libraries. The sample client connects to a sandbox environment hosted by ADP, and comes preconfigured with the necessary credentials and certificates to connect to the sandbox server.
Authorization Code Example
$ git clone https://github.com/adplabs/adp-connection-node.git$ cd adp-connection-node$ npm install$ node authorizationCodeExample
Client Credentials Example
$ git clone https://github.com/adplabs/adp-connection-node.git$ cd adp-connection-node$ npm install$ node clientCredentialsExample
Test Execution
$ npm test
Code Coverage
$ npm run coverage
Lint
$ npm run lint