# @shoppersshop/api-js

> Javascript Library for interacting with the SHOP API

Latest version **1.0.4** (published 2018-03-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @shoppersshop/api-js
pnpm add @shoppersshop/api-js
yarn add @shoppersshop/api-js
bun add @shoppersshop/api-js
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2018-03-28 |
| First published | 2018-03-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 352.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | SHOP team |
| Maintainers | ajhurliman, jmataya |
| Keywords | shopcommerce, api |

## Links

- npm: https://www.npmjs.com/package/@shoppersshop/api-js
- Repository: https://github.com/ShoppersShop/api-js
- Homepage: https://github.com/ShoppersShop/api-js#readme
- Issues: https://github.com/ShoppersShop/api-js/issues
- npm.io page: https://npm.io/package/@shoppersshop/api-js

## Dependencies (5)

- [debug](https://npm.io/package/debug.md) ^2.2.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [jwt-decode](https://npm.io/package/jwt-decode.md) ^2.0.1
- [superagent](https://npm.io/package/superagent.md) ^3.5.2
- [postinstall-build](https://npm.io/package/postinstall-build.md) ^0.2.1

## Recent versions

- 1.0.4 (latest) — 2018-03-28
- 1.0.3 — 2018-03-24
- 1.0.2 — 2018-03-22
- 1.0.1 — 2018-03-22
- 1.0.0 — 2018-03-22

## README

# SHOP API.js

## Overview

API.js is a JavaScript library that helps SHOP Protocol developers create
powerful, customized storefronts on top of the SHOP Protocol API. It does
this by creating an easy abstraction of available API operations and by 
providing convenient helper methods.

This API layer is framework agnostic as we don't to impose a framework decision
such as React or Angular on customers.

API.js will be build in ES6 and transpiled to ES5. It won't use ES7 features.

[API documentation](https://shoppersshop.github.io/api-js/)

# Installation

```
$ yarn add @shoppersshop/api-js
```

# Usage

```
import ShopAPI from `@shoppersshop/api-js`
// args could include API domain & path data, public_key, etc
const api = new ShopAPI({ args })
```

# Contributing

Thanks for considering to help out with our source code! We operate on an open 
contributor model where anyone across the Internet can help in the form of peer
preview, testing, and patches.

For more details about how to get involved, see our
[Contribution Guide](https://github.com/ShoppersShop/shop-token/blob/master/CONTRIBUTING.md)

# License

MIT

---
_Source: https://npm.io/package/@shoppersshop/api-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._