@uphold/uphold-sdk-javascript

Uphold SDK for JavaScript

Showing:

Popularity

Downloads/wk

584

GitHub Stars

69

Maintenance

Last Commit

9mos ago

Contributors

13

Package

Dependencies

8

Size (min+gzip)

233.5KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Uphold SDK for JavaScript

This SDK is built on top of the Uphold API and it's designed to help developers integrate Uphold services into their applications, by making it easier for them to interact with the API in a clean and controlled manner.

It provides developers the facilities to handle authentication, requests, pagination and error handling.

Documentation

Please consult the documentation website for a more detailed specification of the SDK and its modules:

Supported platforms

This SDK can be used on both browser and Node.js environments.

There are no major dependencies other than the fact that it uses the Fetch API to perform network requests, which some browsers do not yet support.

However, you can easily cover your bases by adding a polyfill. If this is a solution you are not comfortable with then please consult the Client documentation and follow the instructions on how to override it.

Usage

In this section we feature a simple usage example:

import SDK from '@uphold/uphold-sdk-javascript';

const sdk = new SDK({
  clientId: 'foo',
  clientSecret: 'bar'
});

sdk.authorize('code')
  .then(() => sdk.getMe())
  .then(user => {
    console.log(user);
  });

Options

Below you can consult the list of available options you can pass to the SDK constructor:

KeyRequiredDefaultDescription
accessTokenKeyNouphold.access_tokenKey used to store the access_token
baseUrlNohttps://api.uphold.comUphold API's url
clientIdYesYour client id
clientSecretYesYour client secret
itemsPerPageNo10Pagination size
refreshTokenKeyNouphold.refresh_tokenKey used to store the refresh_token
versionNov0Uphold API's version

Installation

To install the SDK just type into your terminal:

$ npm install @uphold/uphold-sdk-javascript

Or, if you're using yarn:

$ yarn add @uphold/uphold-sdk-javascript

Feedback, bugs & contributions

Contributions are welcome, consult the guidelines for contributing for instructions.

License

MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial