australia_post_api

AustraliaPostApi - JavaScript client for australia_post_api The API for Australia Post This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install australia_post_api --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your australia_post_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('australia_post_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/australia_post_api then install it via:

    npm install YOUR_USERNAME/australia_post_api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var AustraliaPostApi = require('australia_post_api');

var defaultClient = AustraliaPostApi.ApiClient.instance;

// Configure API key authorization: Auth_key
var Auth_key = defaultClient.authentications['Auth_key'];
Auth_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Auth_key.apiKeyPrefix['AUTH-KEY'] = "Token"

var api = new AustraliaPostApi.DefaultApi()

var opts = { 
  'serviceCode': "serviceCode_example", // {String} Origin postcode
  'fromPostcode': "fromPostcode_example", // {String} Origin postcode
  'toPostcode': "toPostcode_example", // {String} Destination postcode
  'length': 8.14, // {Number} Length in cm of the parcel
  'width': 8.14, // {Number} width in cm  of the parcel
  'height': 8.14, // {Number} height in cm  of the parcel
  'weight': 8.14 // {Number} weight in kg of the parcel
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculateDelivery(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://digitalapi.auspost.com.au

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AustraliaPostApi.DefaultApi | calculateDelivery | GET /postage/parcel/domestic/calculate.json | AustraliaPostApi.DefaultApi | getSizes | GET /postage/parcel/domestic/size.json | AustraliaPostApi.ServiceApi | getDomesticLetterServices | GET /postage/letter/domestic/service.json | AustraliaPostApi.ServiceApi | getDomesticServices | GET /postage/parcel/domestic/service.json | AustraliaPostApi.ServiceApi | getInternationalLetterServices | GET /postage/letter/international/service.json | AustraliaPostApi.ServiceApi | getInternationalService | GET /postage/parcel/international/service.json | AustraliaPostApi.ServiceApi | getServices | GET /postage/v4/catalogue/service.json |

Documentation for Models

Documentation for Authorization

Auth_key

• Type: API key
• API key parameter name: AUTH-KEY
• Location: HTTP header