https://github.com/stitchng/maxdotng
A NodeJS Wrapper for MaxNG API - https://developers.max.ng/
https://github.com/stitchng/maxdotng
api-endpoints automated-deliveries estimates lastmile-delivery logistics maxng nodejs periods pickup-window pickups rest-api
Last synced: 5 months ago
JSON representation
A NodeJS Wrapper for MaxNG API - https://developers.max.ng/
- Host: GitHub
- URL: https://github.com/stitchng/maxdotng
- Owner: stitchng
- License: mit
- Created: 2019-03-04T11:44:10.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-02T06:56:47.000Z (about 3 years ago)
- Last Synced: 2025-04-06T17:49:34.195Z (11 months ago)
- Topics: api-endpoints, automated-deliveries, estimates, lastmile-delivery, logistics, maxng, nodejs, periods, pickup-window, pickups, rest-api
- Language: JavaScript
- Size: 162 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# maxdotng
[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
A NodeJS Wrapper for [MaxNG](https://developers.max.ng)
## Overview
This project provides an easy-to-use object-oriented API to access endpoints delineated at https://maxv1.docs.apiary.io/
## Installation
>Install from the NPM Registry
```bash
npm i --save maxng-nodejs
```
## Usage
```js
let MaxNg = require('maxng-nodejs')
const APIKEY = 'pk_1IkXmSWOlE4y9Inhgyd6g5f2R7'
const environment = process.env.NODE_ENV
const isProduction = (environment === 'production')
const maxdotng = new MaxNg(APIKEY, isProduction);
let response = {body:{}};
const date_time = new Date('2019-12-30')
try {
response = await maxdotng.getPickUpWindow({
pickup_datetime: date_time
});
}catch(err){
console.error(err);
}
```
## API Resources
- maxdotng.getDeliveryRequestStatus()
- maxdotng.getOrderPickupWindows()
- maxdotng.scheduleDeliveryRequest()
- maxdotng.getDeliveryRequest()
- maxdotng.getPickUpWindow()
## License
MIT
# Contributing
You are welcome to contribute to this project. Just before sending us a PR, do the following below:
>Firstly, clone the project
```bash
git clone https://www.github.com/stitchng/maxdotng
```
>Then, lint the code to conform to our code style
```bash
npm run lint
```
>Finally, add tests to the test folder to test your code and run tests locally
```bash
npm run test
```
## Credits
- [Ifeora Okechukwu](https://twitter.com/isocroft)
## Contributing
See the [CONTRIBUTING.md](https://github.com/stitchng/maxdotng/blob/master/CONTRIBUTING.md) file for info
[npm-image]: https://img.shields.io/npm/v/maxng-nodejs.svg?style=flat-square
[npm-url]: https://npmjs.org/package/maxng-nodejs
[travis-image]: https://img.shields.io/travis/stitchng/maxdotng/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/stitchng/maxdotng