citeright-sdk-js
TypeScript icon, indicating that this package has built-in type declarations

1.0.120 • Public • Published

CiteRight SDK

CiteRight exposes much of its functionality through a publicly accessible API. This SDK will help developers use the API to create applications of their own that use CiteRight user data.

Before you start, please contact our support and get a Client Identifier for your application.

Installation

To install, simply install this NPM package

npm install citeright-sdk-js

Usage

To use this package, simply construct a new SDK instance, using the endpoint and application identifier provided by support.

const sdk = new CiteRightSDK(
    "https://api.citeright.net/api",
    "yourApplicationClientIdentifier",
);

sdk.login("citeright_user_username", "citeright_user_password")
    .then((user: UserDTO) => {
        // Do whatever you want!
        // Like... get a list of items for the connected user
        sdk.getItems("search term").then((items: ItemDTO[]) => {
        });
    });

Making Changes

  • Log in to npmjs.com using local command "npm login"
  • Commit changes to remote repository (local copy must be clean to continue)
  • type: npm run publish-node-module

Additional Documentation

To learn more about our API, refer to our API docs, located at https://api.citeright.net/api-docs/.

Package Sidebar

Install

npm i citeright-sdk-js

Weekly Downloads

8

Version

1.0.120

License

GPL-3.0

Unpacked Size

178 kB

Total Files

137

Last publish

Collaborators

  • fred_citeright