ylift
TypeScript icon, indicating that this package has built-in type declarations

2.12.0 • Public • Published

Y LIFT Javascript Client

Version Build Status Downloads Try on RunKit

A JavaScript interface to the Y LIFT API. To get started install via npm:

npm install --save ylift

Getting Started

First, you'll need to register a client application. This can currently only be done by reaching out to the engineering team.

Single Page Apps

const ylift = require('ylift');
 
const client = ylift.create({
  clientId: 'CLIENT_ID',
  redirectUri: 'http://www.example.com/oauth/callbacks/ylift'
});
 
// Send the user to the authorization URL, where they can choose to grant your
// app permissions to access the service on their behalf (if permission has
// already been given, they'll automatically be redirected)
window.location = client.getAuthorizeUri('token');
 
// token will be returned as the query param `authToken` to your redirect URL
const querystring = require('query-string');
const parsed = querystring.parse(location.hash);
client.setAccessToken(parsed.access_token);

NOTE: The process of token retrieval will need to be performed again when the token becomes invalid (they're currently valid for 24 hours).

Server Applications

Because servers can be trusted to keep a secret, setup is much more straightforward.

Client Authentication:

const ylift = require('ylift');
 
const client = ylift.create({
  clientId: 'CLIENT_ID',
  clientSecret: 'CLIENT_SECRET'
});

Acting on behalf of a user:

const redirectUrl = client.getAuthorizeUri('code');
 
// Send the user to the authorization URL, where they can choose to grant your
// app permissions to access the service on their behalf (if permission has
// already been given, they'll automatically be redirected)
 
// the code to exchange will be returned as the query param `code` to your
// redirect URL
const querystring = require('query-string');
const parsed = querystring.parse(location.search);
client.setAuthorizationCode(parsed.code);

Parameters

Parameter Usage Example
clientId* Registered Client ID '46ef9d9b-89a9-4fd2-84cf-af6de31f2618'
clientSecret Registered Client Secret '59170c3e-e2c9-4244-92d8-c3595d4af325'
baseApiUrl Specify an alternate server to request resources from 'https://stage.api.ylift.com/v1'
baseAuthUrl Specify an alternate server to request auth tokens from 'https://stage.accounts.ylift.com'
redirectUri Path to redirect auth requests to (required for #get_authorize_uri) 'https://app.example.com/oauth/callbacks/ylift'
request axios is used under the hood, pass a config through here

Basic Usage

client.products.get('SOME_PRODUCT_ID')
  .then(product => console.log(product))
  .catch(err => console.log('Got an error!', err));

Resources

Notes

  • * and bolded Type indicates required param
  • All list resources have a max of 50 elements per request (e.g. limits higher than that will have no effect)
Entity Method Base

TODO

Readme

Keywords

Package Sidebar

Install

npm i ylift

Weekly Downloads

23

Version

2.12.0

License

MIT

Unpacked Size

805 kB

Total Files

330

Last publish

Collaborators

  • njgerner
  • pwerth
  • yevhen.shevchenko
  • denystom