Quickstart

Before you start, you need:

OrgName and ApiKey: issued by Noyax.
User ID (X-UserID): the Noyax user the requests are made on behalf of.
Company ID (X-CompanyID): the company whose data you access. The user must be assigned to this company.

Get an access token

Exchange your API key for an access token and a refresh token at the auth service.

curl -X POST https://app.noyax.com/services/bb_auth_service/api/ApiAuth/login \
  -H "Content-Type: application/json" \
  -d '{
    "OrgName": "YOUR_ORG_NAME",
    "ApiKey": "YOUR_API_KEY"
  }'

{
  "Data": {
    "AccessToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImFwaSIs...",
    "RefreshToken": "q3Jv1mYt8Rk0bXw2LzH5nD7sPfA9cGe4..."
  },
  "Success": true,
  "Message": null
}

Access tokens are short-lived. When one expires, use the refresh token to get a new one. See Authentication.

Make your first request

Put the token in the Authorization header and the user and company IDs in X-UserID and X-CompanyID.

curl "https://api.noyax.com/api/v1/customers?page=1&pageSize=10" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "X-UserID: 12" \
  -H "X-CompanyID: 3"

using var client = new HttpClient { BaseAddress = new Uri("https://api.noyax.com/api/v1/") };
client.DefaultRequestHeaders.Authorization = new("Bearer", accessToken);
client.DefaultRequestHeaders.Add("X-UserID", "12");
client.DefaultRequestHeaders.Add("X-CompanyID", "3");

var json = await client.GetStringAsync("customers?page=1&pageSize=10");

const response = await fetch("https://api.noyax.com/api/v1/customers?page=1&pageSize=10", {
  headers: {
    Authorization: `Bearer ${accessToken}`,
    "X-UserID": "12",
    "X-CompanyID": "3",
  },
});
const result = await response.json();

import requests

response = requests.get(
    "https://api.noyax.com/api/v1/customers",
    params={"page": 1, "pageSize": 10},
    headers={
        "Authorization": f"Bearer {access_token}",
        "X-UserID": "12",
        "X-CompanyID": "3",
    },
)
result = response.json()

Read the response

Records are in Data.Items and the total record count is in Data.TotalCount.

{
  "Success": true,
  "ResultCode": "0000",
  "Message": null,
  "Data": {
    "Page": 1,
    "PageSize": 10,
    "TotalCount": 128,
    "Items": [
      {
        "Id": "3f2b8c1e-5d47-4a9b-9e21-6c0d8f7a1b24",
        "CustomerCode": "0000382026",
        "Name": "Example Trading Ltd.",
        "TaxNumber": "1234567890",
        "MovementType": 3
      }
    ]
  }
}

The X-Daily-Remaining response header shows how many requests you have left today.

Next steps

Create a customer

Create a customer with addresses, telephones and other sub-records in one request.

Handle errors

Learn which HTTP status code is returned in which case.

Getting started

Core concepts

Modules

Release notes

Next steps

Create a customer

Handle errors

​Next steps

Create a customer

Handle errors

Next steps