API Key Authentication

Authenticate API Key

POST /api/.../authentication/staffuser

Authenticate API key.

The API key is sent via a request header named 'x-api-key'.

The return object from the API key authentication method does not include an access token or access secret.

Request Information

HTTP Header Values
Name Required Description
x-api-key Yes Contains the API key.
Request body
None

Response Information

Example
application/json, text/json 
{
  "SiteDomain": "",
  "UserDomain": "",
  "AccessToken": "",
  "AccessSecret": "",
  "AuthExpDate": null,
  "PolarisUser": {
    "PolarisUserID": 1,
    "OrganizationID": 5,
    "Name": "PolarisExec",
    "BranchID": null,
    "Enabled": true,
    "CreatorID": 1,
    "ModifierID": 1,
    "CreationDate": null,
    "ModificationDate": "2020-12-11T10:28:20.69-05:00"
  },
  "ERMSNetworkAddress": "clvitn-pc197yjl.polarislibrary.com",
  "DataSource": "CLVITN-PC197YJL",
  "SiteCode": "MIS/"
}

HTTP Response Codes

Code Description
200 OK. Success
401 Unauthorized