https://github.com/ecomplus/client
Isomorphic JS client for E-Com Plus REST APIs
https://github.com/ecomplus/client
axios-promises ecomclient ecommerce-apis ecomplus headless-ecommerce js-client rest-apis store-api
Last synced: 9 months ago
JSON representation
Isomorphic JS client for E-Com Plus REST APIs
- Host: GitHub
- URL: https://github.com/ecomplus/client
- Owner: ecomplus
- License: mit
- Created: 2019-07-19T16:58:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-16T03:48:58.000Z (about 1 year ago)
- Last Synced: 2025-04-02T20:57:00.254Z (9 months ago)
- Topics: axios-promises, ecomclient, ecommerce-apis, ecomplus, headless-ecommerce, js-client, rest-apis, store-api
- Language: JavaScript
- Homepage: https://developers.e-com.plus/client/
- Size: 3.69 MB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# E-Com Plus Client
[](https://github.com/ecomplus/client/actions?workflow=Publish) [](https://www.codefactor.io/repository/github/ecomplus/client) [](https://www.npmjs.org/@ecomplus/client) [](https://opensource.org/licenses/MIT)
JS client for E-Com Plus REST APIs
[CHANGELOG](https://github.com/ecomplus/client/blob/master/CHANGELOG.md)
## Usage
**TL;DR**: We have [methods](https://developers.e-com.plus/client/ecomClient.html) to run requests for almost all E-Com Plus APIs, but you're probably searching for [Store API](https://developers.e-com.plus/client/ecomClient.html#.store).
The `@ecomplus/client` package provides a [list of methods](https://developers.e-com.plus/client/ecomClient.html), each one is a function to request a specific E-Com Plus REST API, using [axios](https://github.com/axios/axios) HTTP client and returning a [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise).
It's available for both Node.js and browser environments.
- [Get started](https://developers.e-com.plus/client/module-@ecomplus_client.html)
- [Methods](https://developers.e-com.plus/client/ecomClient.html)
### Store API request example
```js
import { store } from '@ecomplus/client'
const authenticationId = 'myAuthenticationId'
const accessToken = 'myAccessToken'
ecomClient.store({
url: '/products.json',
authenticationId,
accessToken,
method: 'post',
data: { sku: '123', name: 'Sample Prduct 123' }
})
.then(({ data, status }) => console.log(status, data))
.catch(error => console.error(error))
```
### Dependencies
It requires and _may not_ include `core-js`, [`axios`](https://github.com/axios/axios) and [`@ecomplus/utils`](https://github.com/ecomplus/utils).
#### Node.js
```bash
npm i --save @ecomplus/utils @ecomplus/client
```
#### Webpack
```bash
npm i --save core-js @ecomplus/utils @ecomplus/client
```
#### CDN
```html
```
`axios` and `ecomUtils` libraries **must be included separately** and available on window scope.
## Development
Fork/clone this repository and install dependencies normally:
```bash
git clone https://github.com/ecomplus/client
cd client
npm i
```
Then you can edit source files and test locally with `npm run serve`.
### Contributing
Please read the [contribution guidelines](CONTRIBUTING.md).
### Deploy
Take a look on `package.json` scripts:
- `npm run doc` - Update jsdoc/docdash generated documentation;
- `npm run release` - Generate changelog and new version;