https://github.com/riennevaplus/channelengine
ChannelEngine API Client for Node.js
https://github.com/riennevaplus/channelengine
Last synced: over 1 year ago
JSON representation
ChannelEngine API Client for Node.js
- Host: GitHub
- URL: https://github.com/riennevaplus/channelengine
- Owner: RienNeVaPlus
- Created: 2022-09-15T11:07:41.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-16T18:43:06.000Z (over 3 years ago)
- Last Synced: 2025-03-06T12:52:52.032Z (over 1 year ago)
- Language: TypeScript
- Size: 16.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ChannelEngine
Unofficial node.js API client for ChannelEngine.
Supports pagination and variable request retries.
Swagger Docs
·
ChannelEngine Docs
·
Issues
Table of Contents
## Getting Started
### Prerequisites
In order to connect to ChannelEngine, a `tenant` and an `apiKey` are required.
The tenant will be provided by ChannelEngine. The API key can then be generated at `https://$TENANT.channelengine.net/apikeys`.
### Installation
Yarn:
```bash
yarn add channelengine
```
NPM:
```bash
npm install channelengine
```
### Example
```ts
import {ChannelEngine} from 'channelengine'
// provided by ChannelEngine
const tenant = 'demo'
const apiKey = 'myApiKey'
// create instance and request IN_PROGRESS orders
const api = new ChannelEngine(tenant, apiKey, {maxRetries: 10, version: 2})
const response = await api.GET('orders', {
statuses: 'IN_PROGRESS'
})
// log result
console.log(res)
```
### Methods
An instance provides the methods `GET`, `POST`, `PATCH`, `PUT` and `DELETE`.
See [Swagger docs](https://demo.channelengine.net/api/swagger/index.html) for details on when to use which method.
### Built With
* [node.js](https://nodejs.org/)
* [node-fetch](https://github.com/node-fetch/node-fetch)
## Licence
MIT
## Contributors
[RienNeVaPlus](mailto:?@rienneva.plus) - ?@rienneva.plus