Shopee Api

A simple wrapper for Shopee Open Platform

Installation

npm install shopee-api

Usage

Create a ShopeeApi Object to get started

const ShopeeApi = require('shopee-api');
 
const shopeeApi = new ShopeeApi({
    isUAT: false,
    shopid: 'YOUR_SHOP_ID',
    partner_id: 'YOUR_PARTNER_ID',
    partner_key: 'YOUR_PARTNER_KEY',
    redirect_uri: 'http://localhost:3000/callback', // callback url when perform OAuth
    webhook_url: 'http://localhost:3000/webhook',
    verbose: false // show more logs
});

API

Build Oauth Url

const authUrl = shopeeApi.buildAuthURL();
 
//then u can redirect user to this url for authentication
res.redirect(authUrl);

Make calls

This package build all the required authorization in the scene behind.
Refer request package for callback params.

shopeeApi.post('/shop/get_partner_shop', {}, function (err, res, body) {
    if(err) {
        throw new Error(err);
    }
    
    console.log(body);
});

This package also return promise instead of callback

shopeeApi.post('/shop/get_partner_shop', {})
    .then(function({body, res}) {
      console.log(body);
    })
    .catch(function(err) {
      console.log(err);
    });

Verify webhook request

This package can build hmac and verify it for you

const isValid = shopeeApi.isValidSignature(req.body, req.headers.authorization);
 
console.log(isValid) // true if equal, false otherwise

Documentation

Kindly visit Official Shopee Docs for more info

Contributing

If you want to contribute to a project and make it better, your help is very welcome. Just send a pr and you are all set.

License

This library is released under the MIT License