Test mode

Test mode is a second, separate NutraSoft account that belongs to you, seeded with realistic data. It is not a mock: it runs the same code, the same database schema and the same API against a different account. If something works against your test account it works against your live data, and if it would corrupt your test account it would have corrupted your live data.

Who can use it

• Test mode needs a paid Enterprise plan, like the API itself. Free trials cannot create a test account.
• The test account follows the plan of the account that owns it. If that plan lapses or moves below Enterprise, test keys stop working too.
• Only the license administrator, or a user they have given Developer access, can create, reset or delete the test account and its keys.

Create the test account

1. In NutraSoft, open Settings, Developer and find the Sandbox card.
2. Pick the business profile the data should be seeded from and create the account. It usually takes under a minute.
3. Create a test key there. It starts with nsk_test_.

You get one test account per account. Creating and resetting it are limited to six times an hour.

Use it

Same base URL, same operations. The key decides the environment, never the URL. GET /organization reports environment as test; check it in your test setup.

curl "https://public-api.nutrasoft.ca/v1/organization" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"

{
  "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"
    ]
  }
}

Reset

Resetting rebuilds the data from the profile and copies your live account's behavioural settings across again. Record ids are not stable across a reset: a product that was id 4471 will not be afterwards. Look records up by code or name instead of hard-coding ids.

What behaves differently

• Outbound integrations do nothing. QuickBooks, Shopify and HubSpot never have credentials on a test account, so it cannot email a customer, create a Shopify order or post to your accounting system.
• It has its own rate limit. Test traffic counts against the test account's 300 requests per minute, not your live budget.
• Its data is disposable. It may be reset or deleted, it is not backed up, and it must not contain real personal information.

Delete it

Deleting the test account removes it and everything in it, and every nsk_test_ key pointed at it stops working immediately. Your live account and its data are untouched. The license administrator, or a user with Developer access, can delete the test account even after a move to a plan without the API.