npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ns8/magento2-rest-client

v0.2.29

Published

REST client for accessing Magento 2 functionality.

Downloads

72

Readme

Magento2 REST client

This Node.js library enables JavaScript applications to communicate with Magento2 sites using their REST API. This module based on magento2-rest-client, which is in turn based on the magento2-rest-client module created by Marko Novak (2016).

This module is used by the NS8 Protect Magento extension. It is safe for production use, but NOTE: the library is not finished yet! Only a subset of Magento2 API is currently implemented. Not all methods are fully documented, and not all return types are fully typed.

Installation

The library can be installed using the Npm package manager:

yarn add @ns8/magento2-rest-client

Usage

The code sample below shows the usage of the library:

import { RestClient } from '@ns8/magento2-rest-client';

const options = {
  url: 'http://www.test.com/index.php/rest',
  consumerKey: '<OAuth 1.0a consumer key>',
  consumerSecret: '<OAuth 1.0a consumer secret>',
  accessToken: '<OAuth 1.0a access token>',
  accessTokenSecret: '<OAuth 1.0a access token secret>'
};
const client = new RestClient(options);
client.categories.list().then( (categories) => {
  assert.equal(categories.parentId, 1);
});

TODO: Allow extending the API by adding your own modules or adding methods to the existing modules!

Contributing

Create issues or submit PRs to extend existing API support or add new functionality. All contributions are welcome.

usefull resources

  • Magento API with Swagger: https://devdocs.magento.com/swagger/
  • Admin API Documentation of Magento: https://devdocs.magento.com/redoc/2.3/admin-rest-api.html
  • Filtered responses: https://devdocs.magento.com/guides/v2.3/rest/retrieve-filtered-responses.html