API - Getting Started

Introduction

The Neto application programmer interface (API) enables third party software to interact with the Neto E-commerce Suite.  Currently all transactions are performed via HTTPS POST.

You can Add, Update, Delete and Get data using the API.

We are intent on continually updating and improving the API in it's current release. Currently, there are functions not available through the API and until such time as we have made all functions available the API will remain in development. Having said that the functions contained in this documentation are tested and available for live environments.

If there is a function or field missing from the API that you require for your project please email support@neto.com.au.

Connecting & Authentication

API requests are submitted through HTTPS POST requests to the Web Services URL of your Neto account. Requests are authenticated with your Neto API key and can be made in XML or JSON (JSON only available in Neto v5.4 and above).

Endpoint URL https://www.yournetosite.com.au/do/WS/NetoAPI
Method POST
XML Headers
NETOAPI_ACTION The request you want to make. Required.
NETOAPI_KEY Your Neto API Secure Key (generate this in your Neto control panel).
NETOAPI_USERNAME Your Neto API username (managed under Staff Users in the Neto control panel). Not required if using a key.
JSON Headers
NETOAPI_ACTION The request you want to make. Required.
NETOAPI_KEY Your Neto API Secure Key (generate this in your Neto control panel).
NETOAPI_USERNAME Your Neto API username (managed under Staff Users in the Neto control panel). Not required if using a key.
Accept application/json

Making Requests

The Neto API currently supports XML and JSON (JSON only available in Neto v5.4 and above) encoded data as requests and responses. For JSON be sure to set the Accept header to application/json to identify the request and response format. Otherwise XML will be returned.

Pagination

The Neto API supports pagination in all Get requests. This allows you to retrieve large amounts of data in small lots. Add the following filters to your Get requests to use this feature.

Filter Name Description
Limit The number of results to return per page
Page The page number of results to return starting at 0.

XML Example

JSON Example


Getting Started

 

1. Get Setup

  • Signup for a free Neto trial account
  • Generate an API key (Go to your Neto Control Panel > admin > system setup > api)

2. Explore

  • Explore the API calls we have available by drilling into these documents
  • Use a client such as "POSTMAN" to test API calls againt your trial account

3. Build

  • Build your integration
  • Checkout our recommended workflows for different app types
  • Ask us if you get stuck, require additional fields, calls or advice

4. List your add-on with Neto

Have a working integration? Neto has a base of over 2,000 Australia retailers, wholesalers and eBay traders.

Get Listed on our Add-on Store by completing the Expression of Interest Form.