Authentication

Good to know: All API end points are configured with Bearer Authentication Login to get your Token

Get your Access Token

Your API requests are authenticated using Bearer Token. Any request that doesn't include Bearer Token will return an error. You can get your token you need to login with your Email and Password.

User login

POST/api/account/login

Body

application/jsontext/jsonapplication/*+json

emailAddress*string (email)

password*string (password)

Response

200400

Success

Body

text/plainapplication/jsontext/json

tokennullable string

expirationstring (date-time)

identityIdnullable string

emailAddressnullable string

Request

JavaScriptCurl

const response = await fetch('/api/account/login', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "emailAddress": "[email protected]",
      "password": "password"
    }),
});
const data = await response.json();

Response

{
  "token": "text",
  "expiration": "2024-05-12T06:47:59.458Z",
  "identityId": "text",
  "emailAddress": "text"
}

Take a look at how you might call this method using different programing languages:

curl

curl --location --request POST '{baseUrl}/api/account/login' \
--header 'Content-Type: application/json' \
--data-raw '{
  "emailAddress": "YOUR_EMAIL_ADDRESS",
  "password": "YOUR_PASSWORD"
}'

Node

var request = require('request');
var options = {
  'method': 'POST',
  'url': '{baseUrl}/api/account/login',
  'headers': {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "emailAddress": "YOUR_EMAIL_ADDRESS",
    "password": "YOUR_PASSWORD"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Python

import requests
import json

url = "{baseUrl}/api/account/login"

payload = json.dumps({
  "emailAddress": "YOUR_EMAIL_ADDRESS",
  "password": "YOUR_PASSWORD"
})
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Using Bearer Token

You need to send Token in Authorization header as Bearer

Search Clients

GET/api/client

Query parameters

Response

200404

Success

Body

text/plainapplication/jsontext/json

clientIDinteger (int32)

isActiveboolean

creatornullable string

creatednullable string (date-time)

updaternullable string

lastUpdatenullable string (date-time)

clientCustom1nullable string

contactContactDto (object)

clientContactsnullable array of ClientContactDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/client', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "isActive": false,
  "creator": "text",
  "created": "2024-05-12T06:47:59.458Z",
  "updater": "text",
  "lastUpdate": "2024-05-12T06:47:59.458Z",
  "clientCustom1": "text",
  "contact": {
    "companyName": "text",
    "lastName": "text",
    "firstName": "text",
    "salutation": "text",
    "creator": "text",
    "created": "2024-05-12T06:47:59.458Z",
    "updater": "text",
    "lastUpdate": "2024-05-12T06:47:59.458Z",
    "website": "text",
    "contactAddress": {
      "street": "text",
      "number": "text",
      "poBox": "text",
      "city": "text",
      "zip": "text",
      "state": "text"
    },
    "contactDetails": [
      {
        "isPreferred": false,
        "value2": "text",
        "updater": "text",
        "lastUpdate": "2024-05-12T06:47:59.458Z"
      }
    ]
  },
  "clientContacts": [
    {
      "firstName": "text",
      "lastName": "text",
      "position": "text",
      "phone": "text",
      "mobile": "text",
      "email": "text",
      "department": "text"
    }
  ]
}

curl

curl --location --request GET '{baseUrl}/api/Client' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '[
  {
    "contactType": 2,
    "companyName": "string",
    "firstName": "string",
    "lastName": "string",
    "salutation": "string",
    "website": "string",
    "position": "string",
    "phone": "string",
    "mobile": "string",
    "email": "[email protected]",
    "department": "string",
    "gender": 1,
    "telMobile": "string",
    "fax": "string",
    "contactAddress": {
      "street": "string",
      "number": "string",
      "poBox": "string",
      "city": "string",
      "zip": "string",
      "state": "string",
      "country": 0,
      "type": 0
    }
  }
]'

Node

var request = require('request');
var options = {
  'method': 'GET',
  'url': '{baseUrl}/api/Client',
  'headers': {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify([
    {
      "contactType": 2,
      "companyName": "string",
      "firstName": "string",
      "lastName": "string",
      "salutation": "string",
      "website": "string",
      "position": "string",
      "phone": "string",
      "mobile": "string",
      "email": "[email protected]",
      "department": "string",
      "gender": 1,
      "telMobile": "string",
      "fax": "string",
      "contactAddress": {
        "street": "string",
        "number": "string",
        "poBox": "string",
        "city": "string",
        "zip": "string",
        "state": "string",
        "country": 0,
        "type": 0
      }
    }
  ])

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Python

import requests
import json

url = "{baseUrl}/api/Client"

payload = json.dumps([
  {
    "contactType": 2,
    "companyName": "string",
    "firstName": "string",
    "lastName": "string",
    "salutation": "string",
    "website": "string",
    "position": "string",
    "phone": "string",
    "mobile": "string",
    "email": "[email protected]",
    "department": "string",
    "gender": 1,
    "telMobile": "string",
    "fax": "string",
    "contactAddress": {
      "street": "string",
      "number": "string",
      "poBox": "string",
      "city": "string",
      "zip": "string",
      "state": "string",
      "country": 0,
      "type": 0
    }
  }
])
headers = {
  'Authorization': 'Bearer {token}',
  'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)