NutraSoft food manufacturing ERP software

v1.1REST · JSON · Enterprise plan

The NutraSoft API

Your catalog, lots, production, sales and purchasing, over one REST API. Build against a test account you can safely break, then switch the key.

Esc
  • GuideGetting startedThree steps to your first call and your first order, then the two shapes every response takes.
  • GuideAuthentication and keysBearer keys, test and live environments, rotation without an outage, and what each scope grants.
  • GuideTest modeA second NutraSoft account of your own, seeded with realistic data, that you can safely break.
  • PageErrorsEvery error code the API returns, what it means, what to do about it and whether to retry.
  • PageConventionsThe rules every operation follows: money, time, paging, sorting, nulls, PATCH and identifiers.
Getting startedBrowse the API mapOpenAPI
Base URLhttps://public-api.nutrasoft.ca/v1
GET /organization
curl "https://public-api.nutrasoft.ca/v1/organization" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"
Response200
{
  "data": {
    "api_key_id": 123,
    "company": "Example Foods Inc.",
    "currency": "CAD",
    "environment": "test",
    "key_prefix": "nsk_test_9fA",
    "license_id": 123,
    "rate_limit_per_min": 300,
    "scopes": [
      "catalog:read",
      "sales:read",
      "sales:write"
    ]
  }
}

The API at a glance

Five modules, each with its own read and write scope. Every node opens its reference.

Essentials

Six things every integration needs to know.

Authentication
Authorization: Bearer <key>

Server side only. No OAuth, cookies or query keys. Keys and scopes

Environments
nsk_live_ · nsk_test_

One base URL: the key decides live or test. Test mode

Rate limit
300 requests / minute

Per account, shared by its keys. Wait for Retry-After on 429. Retries

Paging
limit 1 to 200 · offset

Stop when has_more is false. Conventions

Errors
{ "error": { "code", "request_id" } }

Branch on code, never on message. Every code

Versioning
/v1 only grows

Breaking changes ship as v2, with 12 months' notice. Versioning

Guides

Need API access?

The NutraSoft API is included in the paid Enterprise plan. Talk to us about your integration, or write to support@nutrasoft.ca.

Book a DemoTalk to Sales