Introduction

Welcome to the Navo API. Use the Navo client to view and create jobs, search transaction history, and view and edit warehouse data.

The Navo client can be used natively with C# and JavaScript. Select your programming language and start reading to learn how you can integrate Navo into your software.

Authentication

To authorize, use this code:

using Navo;
// the C# client authenticates in the constructor
var client = new NavoClient("http://your-navo-server", yourApiKey);

const navo = require('navo');
let client = navo.client('http://your-navo-server', authKey);

# With shell, you can just pass the correct header with each request
curl "http://your-navo-server/api"
  -H "Authorization: YOURAPIKEY"

The yourApiKey variable needs to contain your API key.

Navo uses API keys to authorize access. You can generate a new Navo API key through our developer portal.

Navo API requests require authorization information (your API key) to be in the request header:

Authorization: yourApiKey

Locations

Get All Locations

using Navo;
var client = new NavoClient("http://your-navo-server", yourAuthToken);
List<Locations> locations = client.Locations.Get();

curl "http://example.com/api/locations"
  -H "Authorization: YourAuthToken"

const navo = require('navo');

let client = navo.client("http://your-navo-server", authKey);
let locations = client.locations.get();

The above command returns JSON structured like this:

[
  {
    "id": 1,
    "name": "Fluffums",
    "breed": "calico",
    "fluffiness": 6,
    "cuteness": 7
  },
  {
    "id": 2,
    "name": "Max",
    "breed": "unknown",
    "fluffiness": 5,
    "cuteness": 10
  }
]

This endpoint retrieves all locations.

HTTP Request

GET http://example.com/api/locations

Query Parameters

Parameter	Default	Description
include_cats	false	If set to true, the result will also include cats.
available	true	If set to false, the result will include locations that have already been adopted.

Get a Location

using Navo;
var client = new NavoClient("http://your-navo-server", yourAuthToken);
Location location = client.Locations.Get();

const navo = require('navo');

let client = navo.client("http://your-navo-server", authKey);
let location = client.locations.get(2);

curl "http://example.com/api/locations/2"
  -H "Authorization: YourAuthToken"

The above command returns JSON structured like this:

{
  "id": 2,
  "name": "Cabinet 1",
  "added": "05/11/2016 08:27:66 am",
  "active": true,
  "children": [] // array will be empty if location does not contain children locations
}

This endpoint retrieves a specific location.

HTTP Request

GET http://example.com/locations/<ID>

URL Parameters

Parameter	Description
ID	The ID of the location to retrieve

Delete a Location

using Navo;
var client = new NavoClient("http://your-navo-server", yourAuthToken);
client.Get();

const navo = require('navo');

let client = navo.client("http://your-navo-server", authKey);
let max = api.locations.delete(2);

curl "http://example.com/api/locations/2"
  -X DELETE
  -H "Authorization: YourAuthToken"

The above command returns JSON structured like this:

{
  "id": 2,
  "deleted" : ":("
}

This endpoint deletes a specific location.

HTTP Request

DELETE http://example.com/locations/<ID>

URL Parameters

Parameter	Description
ID	The ID of the location to delete

Transactions

A Navo transaction is created anytime a material operation is performed.

Get All Transactions

using Navo;
var client = new NavoClient("http://your-navo-server", yourAuthToken);
List<Transactions> transactions = client.Transactions.Get();

curl "http://example.com/api/transactions"
  -H "Authorization: YourAuthToken"

const navo = require('navo');

let client = navo.client("http://your-navo-server", authKey);
let transactions = client.transactions.get();

The above command returns JSON structured like this:

[
  {
    "id": 1,
    "part": "08-324-161",
    "serial": "9F727",
    "user": "Frank Castle",
    "date": "05/11/2016 08:27:46 am",
    "attachments": []
  },
  {
    "id": 2,
    "part": "54-424-664",
    "serial": "2T553",
    "user": "Karen Paige",
    "date": "05/22/2016 10:32:02 pm",
    "attachments": []
  }
]

This endpoint retrieves all transactions (200 max).

HTTP Request

GET http://example.com/api/transactions

Query Parameters

Parameter	Default	Description
include_cats	false	If set to true, the result will also include cats.
available	true	If set to false, the result will include transactions that have already been adopted.

Get a Location

using Navo;
var client = new NavoClient("http://your-navo-server", yourAuthToken);
Location location = client.Transactions.Get();

const navo = require('navo');

let client = navo.client("http://your-navo-server", authKey);
let location = client.transactions.get(2);

curl "http://example.com/api/transactions/2"
  -H "Authorization: YourAuthToken"

The above command returns JSON structured like this:

{
  "id": 2,
  "name": "Cabinet 1",
  "added": "05/11/2016 08:27:66 am",
  "active": true
}

This endpoint retrieves a specific location.

HTTP Request

GET http://example.com/transactions/:id

URL Parameters

Parameter	Description
ID	The ID of the location to retrieve

Delete a Location

using Navo;
var client = new NavoClient("http://your-navo-server", yourAuthToken);
client.Get();

const navo = require('navo');

let client = navo.client("http://your-navo-server", authKey);
let max = api.transactions.delete(2);

curl "http://example.com/api/transactions/2"
  -X DELETE
  -H "Authorization: YourAuthToken"

The above command returns JSON structured like this:

{
  "id": 2,
  "deleted" : ":("
}

This endpoint deletes a specific location.

HTTP Request

DELETE http://example.com/transactions/:id

URL Parameters

Parameter	Description
ID	The ID of the location to delete