Register Site

POST /engage/sites/register

This API registers a new site with the provided base64 encoded site key and can only be accessed by a partner account type. ENGAGE managed login types are not able to access this API.

Once the site is created, the site key cannot be changed.

The response contains the reference ID for the newly created site. This is the unique identifier for this site.

Authorization

Basic Authentication, must be a partner managed account type

Request

Body Parameters

Type: application/json

• SiteName = string (required)

  • Friendly name of site that is displayed on mobile and web apps.

• Base64Key = string (required)

  • The 32-byte Site Key encryption key. The value is a hexadecimal value that is encoded in Base64 format.

  NOTE: The value should be Base64 encoded starting as a hexadecimal string of characters, not an ASCII representation of a hexadecimal string.

• IsEngageManaged = boolean (optional)

  • If set to TRUE, the site will be an Allegion ENGAGE managed site. If set to FALSE a partner managed site type will be created. If parameter is not included with request, the site will be created as a partner managed site type.

• DefaultHostAddress = string (optional)

  • A URL to change the site’s default hostname location. Value must be a valid URL including http or https. Only valid when IsEngageManaged == FALSE. This is an optional feature of site creation that is intended to reduce occurrences of manual errors created during commissioning of devices that will make client connection (e.g. Wi-Fi) requests to a partner managed server for database updates & audit posting.

• SiteSoftwareKey = string (required)

  • This string should be identical to the “Value” string provided by GET /engage/lookup/sitesoftware

Example:

POST /engage/sites/register HTTP/1.1

Host: partner.lockwebserv.com

Content-Type: application/json

Authorization: Basic c2l0ZUFkbWluQHNvZnR3YXJlLmNvbTpFTkdBR0UxMjM0NTY=

{

    "SiteName":"New Site",

    "Base64Key":"AQIDBAUGBwgJCgsMDQ4PEBESExQVFhcYGRobHB0eHyA=",

    "IsEngageManaged":"False",

    "DefaultHostAddress":"http://www.securitycompany.com/",

    “SiteSoftwareKey”:”identicard”

}

Response

HTTP status code 201

• OK – New site created

Body

Type: application/json – reference ID for site

Example:

"ca530998-d21a-494b-b637-ba38ad42fd2d"

HTTP status code 400

Bad Request - most likely arguments passed in are invalid.

Example:

"The site software key provided ‘invalidSAM' is invalid."

HTTP status code 401

Unauthorized - Credentials were not provided or are invalid.

HTTP status code 500

Something happened, we are looking into it.