@carimflex/rodonaves-js

1.0.3 • Public • Published

Rodonaves Client API - By CarimFlex

npm (scoped) Build Status codecov semantic-release

A JavaScript library to interface with Rodonaves API, it works in the browser and with Node.js. The documentation can be found here.

Do you like?

Please, consider supporting my work as a lot of effort takes place to create this component! Thanks a lot.

Buy Me A Coffee

How to use

Browser using CDN (Rodonaves + Axios + QS)

<script src="//cdn.jsdelivr.net/combine/npm/axios@0.19.2/dist/axios.js,npm/qs@6.9.3/dist/qs.js,npm/@carimflex/rodonaves-js@1.0.0/dist/rodonaves-js-browser.js"></script>

npm

$ npm install --save @carimflex/rodonaves-js

Example

import Rodonaves from '@carimflex/rodonaves-js';

const rodonaves = new Rodonaves(
  'user',
  'password',
);
const response = await rodonaves.getCityByZipCode('12608220');

API Docs

This library provides a promise based interface for all functions. Before you can use the library, you need to provide authentication details which will be used through API calls.

For a detailed documentation, see our Documentation.

To do

  • [x] Function getCityByZipCode(zipCode)
  • [x] Function getDeliveryTime(originZipCode, destinationZipCode)
  • [x] Function simulateQuote(originZipCode, destinationZipCode, packs, invoiceValue, destinationTaxId)
  • [ ] Function getCityByName(name)
  • [ ] Function tracking(name)
  • [ ] Function quote()
  • [ ] Function updateQuote()

Package Sidebar

Install

npm i @carimflex/rodonaves-js

Weekly Downloads

0

Version

1.0.3

License

Apache-2.0

Unpacked Size

60.7 kB

Total Files

8

Last publish

Collaborators

  • jonycelio