Aurmur API

If you are interested in Aurmur's API, please  contact support
.

Contents



Permanent Token

Permanent tokens are created and managed through Aurmur's website.


Go to the Account > API Menu.




Temporary Token

To call the other APIs, a permanent token needs to be used to get a temporary token. The temporary token will be valid for 24 hours from the time it was created.

URL: POST https://api.aurmur.com/v1/authentication/

Header: x-permanent-token

Response

FieldDescriptionType
temporary-tokenTemporary token used for calling other APIString
epoch-timeEpoch time when token expires (24 hours from creation)String

Request
$ curl -X POST -H " x-permanent-token: 0dKcXa/CisrIDNlqfCnzsGSjplQU7tDsoR05fFpzJPa2V15xoKDLwuvL/jDceNVDvLDq7m0jg1OY01mySptlw==" https://api.aurmur.com/v1/authentication/

Response
'{
"temporary-token": "Pb61gMHBOP2QiTyDgdBoB5riwzaMJbyjd09Av2CG2t4ztvt8Q09kDu6At91npgS7ifTHpV2nnhWPt8L3omF1g==",
"expiration-epoch": 1578500893
}'



List Locks

List the locks which are registered in linked SmartThings accounts.

URL: GET https://api.aurmur.com/v1/listlocks/

Header: x-temporary-token

Response

FieldDescriptionType
JSON Array
lock-idID for lock. Same ID as lock deviceid in SmartThingsString
lock-nameLock name in AurmurString
smartthings-nameName from SmartThingsString

Request
$ curl -X GET -H " x-temporary-token: Pb61gMHBOP2QiTyDgdBoB5riwzaMJbyjd09Av2CG2t4ztvt8Q09kDu6At91npgS7ifTHpV2nnhWPt8L3omF1g==" https://api.aurmur.com/v1/listlocks/

Response
'[
{
"lock-id": "ba01e46e8-e1be-4803-8d22-d3398f325d44",
"lock-name": "Front Door",
"smartthings-name": "Yale Assure Lock Push Button Deadbolt"
},'
{
"lock-id": "aa5e46e9-e1be-5801-8d32-e3498f325e55",
"lock-name": "Back Door",
"smartthings-name": "Yale Assure Lock Push Button Deadbolt"
}'
]'



Unlock

Unlocks a lock.

URL: PUT https://api.aurmur.com/v1/unlock/<lock-id>

Header: x-temporary-token

Response: Empty

Request
$ curl -X PUT -H " x-temporary-token: Pb61gMHBOP2QiTyDgdBoB5riwzaMJbyjd09Av2CG2t4ztvt8Q09kDu6At91npgS7ifTHpV2nnhWPt8L3omF1g==" https://api.aurmur.com/v1/unlock/ba01e46e8-e1be-4803-8d22-d3398f325d44



Lock

Locks a lock.

URL: PUT https://api.aurmur.com/v1/lock/<lock-id>

Header: x-temporary-token

Response: Empty

Request
$ curl -X PUT -H " x-temporary-token: Pb61gMHBOP2QiTyDgdBoB5riwzaMJbyjd09Av2CG2t4ztvt8Q09kDu6At91npgS7ifTHpV2nnhWPt8L3omF1g==" https://api.aurmur.com/v1/lock/ba01e46e8-e1be-4803-8d22-d3398f325d44



Lock Status

Show the status of locks.

URL: GET https://api.aurmur.com/v1/lockstatus/?lock-id=<lock-id>

Header: x-temporary-token

Request

FieldDescriptionType
lock-idlock-id for which to get status information.
lock-id=all can be provided to return all lock status information
String


Response

FieldDescriptionType
JSON Array
lock-idID for lock. Same ID as lock deviceid in SmartThings.String
lock-nameLock name in Aurmur.String
stateLock state

Values: locked, unlocked, unknown
String
batteryBattery PercentageNumber (Optional)
last-updateMinutes since lock last communicated.Number

Request
$ curl -X GET -H " x-temporary-token: Pb61gMHBOP2QiTyDgdBoB5riwzaMJbyjd09Av2CG2t4ztvt8Q09kDu6At91npgS7ifTHpV2nnhWPt8L3omF1g==" https://api.aurmur.com/v1/lockstatus?lock-id=all

Response
'[
{
"lock-id": "ba01e46e8-e1be-4803-8d22-d3398f325d44",
"lock-name": "Front Door",
"state": "locked",
"battery": 50,
"last-update": 20
},'
{
"lock-id": "aa5e46e9-e1be-5801-8d32-e3498f325e55",
"lock-name": "Back Door",
"state": "unlocked",
"battery": 80,
"last-update": 5
}'
]'



Lock Events

Show locks lock and unlock activity.

URL: GET https://api.aurmur.com/v1/lockevents?lock-id=<lock-id>

Header: x-temporary-token

Request

FieldDescriptionType
lock-idlock-id for which to get lock events.
lock-id=all can be provided to return events for all locks.
String


Response

FieldDescriptionType
JSON Array
lock-event-idLock event IDString
lock-idID for lock. Same ID as lock deviceid in SmartThings.String
lock-nameLock name in Aurmur.String
actionWhether locks was locked, unlocked, jammed, or tampered.

Values: locked, unlocked, jammed, or tampered
String
methodHow action was performed.

Values: manual, keypad, portal, api
String (Optional)
kindKind of code used.

Only relevant for unlock actions.
Values: guest, programmed, or unknown
String (Optional)
listing-idListing ID

Only relevant for guest and programmed unlock actions.
String (Optional)
listing-nameListing name

Only relevant for guest and programmed unlock actions.
String (Optiona)
used-codeMemory location in lock's memory

Only relevant for unlock actions.
String (Optional)
code-idCode ID

Only relevant for guest and programmed unlock actions.Only relevant for guest and programmed unlock actions.
String (Optional)
code-nameName of code

Only relevant for unlock actions with programmed codes.
String (Optional)
guest-informationGuest information

Only relevant for guest unlocking with automated guest code.
String (Optional)
event-epochEpoch time of event.Number

Request
$ curl -X GET -H " x-temporary-token: Pb61gMHBOP2QiTyDgdBoB5riwzaMJbyjd09Av2CG2t4ztvt8Q09kDu6At91npgS7ifTHpV2nnhWPt8L3omF1g==" https://api.aurmur.com/v1/lockevents?lock-id=all

Response
'[
{
"lock-event-id": "057a87f3-b6a5-4b67-b74b-b03c0492d406",
"lock-id": "ba01e46e8-e1be-4803-8d22-d3398f325d44",
"lock-name": "Front Door",
"action": "unlocked",
"method" : "keypad",
"type" : "programmed",
"listing-id" : "CR1KtOV5nBpY91",
"listing-name" : "quiet house",
"used-code" : "5",
"code-id" : "095218ab-6206-47c5-857d-52cf9412a594",
"code-name" : "backup code",
"event-epoch": 1573494097
},
{
"lock-event-id": "432acccc-ab44-4247-9cc5-ca52392c3432",
"lock-id": "0a3c1330-893d-4dc9-a82d-9e7fcdcf7ca9",
"lock-name": "Back Door",
"action" : "locked",
"event-epoch": 1568740407
},
{
"lock-event-id": "0e4536b9-bf5d-4025-8b90-223eae509b28",
"lock-id": "0a3c1330-893d-4dc9-a82d-9e7fcdcf7ca9",
"lock-name": "Back Door",
"action": "unlocked",
"method" : "keypad",
"type" : "guest",
"listing-id" : "CR1KtOV5nBpY91",
"listing-name" : "quiet house",
"used-code" : "6",
"code-id" : "0e80614f-cb8f-4193-885d-47ace1a1f7d4",
"guest-information" : "John Doe (HMADTA3N3C)",
"event-epoch": 1568584612
}
]'



List Codes

List programmed codes.

URL: GET https://api.aurmur.com/v1/codes

Header: x-temporary-token

Response

FieldDescriptionType
JSON Array
code-idCode IDString
code-nameCode nameString
listing-idListing IDString
listing-nameName of listingString
deletedSet to true when code is in process of being deletedBoolean
statusStatus of code

Values: activation_pending, activation_pending_with_failure, activated, deactivated, deactivation_pending, deactivation_pending_with_failure, new
String
lock-statusStatus of code per lockJSON Array of Lock Information Objects
manualManually manage activation and deactivation.

Values: activated or deactivated.
If this is set, then the daterange, hoursperday, and daysofeachweek cannot be set.
String (Optional)
unlock-notificationsNotifications to be sent when unlocked

Values: first-use, every-use
String (Optional)
daterangestartStart of date range for code to be activate.

Format: MM/dd/yyyy hh:mm a
String (Optional)
daterangeendEnd of date range for code to be activate.

Format: MM/dd/yyyy hh:mm a
String (Optional)
hoursperdaystart Start of hour range that a code is activate.

Format: 1 to 24 (inclusive)
Number (Optional)
hoursperdayend End of hour range that a code is activate.

Format: 1 to 24 (inclusive)
Number (Optional)
daysofeachweek Days of week that code should be active.

Values: monday, tuesday, wednesday, thursday, friday, saturday, sunday
JSON Array of Strings


Lock Information

FieldDescriptionType
lock-idLock IDString
statusStatus of code

Values: activation_pending, activation_pending_with_failure, activated, deactivated, deactivation_pending, deactivation_pending_with_failure, new
String

Request
$ curl -X GET -H " x-temporary-token: Pb61gMHBOP2QiTyDgdBoB5riwzaMJbyjd09Av2CG2t4ztvt8Q09kDu6At91npgS7ifTHpV2nnhWPt8L3omF1g==" https://api.aurmur.com/v1/codes

Response
'[
{
"code-id" : "095218ab-6206-47c5-857d-52cf9412a594",
"code-name" : "backup code",
"listing-id" : "CR1KtOV5nBpY91",
"listing-name" : "quiet house",
"status" : "activated",
"unlock-notifications" : "every-use"
},
{
"code-id" : "095218ab-6206-47c5-857d-52cf9412a594",
"code-name" : "guest code for quiet house",
"listing-id" : "CR1KtOV5nBpY91",
"listing-name" : "quiet house",
"status" : "deactivated",
"unlock-notifications" : "first-use",
"daterangestart": "11/27/2019 09:00 AM",
"daterangeend": "11/29/2019 11:15 AM"
}
]'



Create Code

Create a code.

URL: POST https://api.aurmur.com/v1/codes/

Header: x-temporary-token

Request

FieldDescriptionType
code-nameCode nameString
listing-idID for listing.String
code4 to 8 digit code to unlock door.Number
unlock-notificationsNotifications to be sent when unlocked

Values: first-use, every-use.
String (Optional)
manualManually manage activation and deactivation.

Values: activated or deactivated.
If this is set, then the daterange, hoursperday, and daysofeachweek cannot be set.
String (Optional)
daterangestartStart of date range for code to be activate.

Format: MM/dd/yyyy hh:mm a
String (Optional)
daterangeendEnd of date range for code to be activate.

Format: MM/dd/yyyy hh:mm a
String (Optional)
hoursperdaystart Start of hour range that a code is activate.

Format: 1 to 24 (inclusive)
Number (Optional)
hoursperdayend End of hour range that a code is activate.

Format: 1 to 24 (inclusive)
Number (Optional)
daysofeachweek Days of week that code should be active.

Values: monday, tuesday, wednesday, thursday, friday, saturday, sunday
JSON Array of Strings (Optional)

Response

FieldDescriptionType
code-idCode IDString

Request
$ curl -X POST -H " x-temporary-token: Pb61gMHBOP2QiTyDgdBoB5riwzaMJbyjd09Av2CG2t4ztvt8Q09kDu6At91npgS7ifTHpV2nnhWPt8L3omF1g==" https://api.aurmur.com/v1/codes --data

'{
"code-name" : "backup code",
"listing-id" : "CR1KtOV5nBpY91",
"code" : 5391
"unlock-notifications" : "every-use"
}'

Response
'{
"code-id" : "095218ab-6206-47c5-857d-52cf9412a594",
}'



Delete Code

Delete a code.

URL: DELETE https://api.aurmur.com/v1/codes/<code-id>

Header: x-temporary-token

Request
$ curl -X DELETE -H " x-temporary-token: Pb61gMHBOP2QiTyDgdBoB5riwzaMJbyjd09Av2CG2t4ztvt8Q09kDu6At91npgS7ifTHpV2nnhWPt8L3omF1g==" https://api.aurmur.com/v1/codes/095218ab-6206-47c5-857d-52cf9412a594



Update Code

Update existing code.

URL: PUT https://api.aurmur.com/v1/codes/<code-id>

Header: x-temporary-token

Request

FieldDescriptionType
code-nameCode name
Previous value is kept if not provided.
String (optional)
unlock-notificationsNotifications to be sent when unlocked

Values: first-use, every-use
String (optional)
manualManually manage activation and deactivation.

Values: activated or deactivated.
If this is set, then the daterange, hoursperday, and daysofeachweek cannot be set.
String (optional)
daterangestartStart of date range for code to be activate.

Format: MM/dd/yyyy hh:mm a
String (optional)
daterangeendEnd of date range for code to be activate.

Format: MM/dd/yyyy hh:mm a
String (optional)
hoursperdaystart Start of hour range that a code is activate.

Format: 1 to 24 (inclusive)
Number (optional)
hoursperdayend End of hour range that a code is activate.

Format: 1 to 24 (inclusive)
Number (optional)
daysofeachweek Days of week that code should be active.

Values: monday, tuesday, wednesday, thursday, friday, saturday, sunday
JSON Array of Strings (optional)

Response: Empty

Request
$ curl -X PUT -H " x-temporary-token: Pb61gMHBOP2QiTyDgdBoB5riwzaMJbyjd09Av2CG2t4ztvt8Q09kDu6At91npgS7ifTHpV2nnhWPt8L3omF1g==" https://api.aurmur.com/v1/codes/41c374d8-ae27-49b4-8ba5-59ad62214261 --data
'{
"code-name" : "backup code #2",
"unlock-notifications" : "first-use",
"manual" : "activated"
}'



List Listings

List listings.

URL: GET https://api.aurmur.com/v1/listings

Header: x-temporary-token

Response

FieldDescriptionType
JSON Array
listing-idListing IDString
code-lengthLength of codes.
Format: 1 to 8 (inclusive)
Number
timezone Timezone to use with listing.

Values: US/Hawaii, US/Alaska, US/Pacific, US/Arizona, US/Mountain, US/Central, US/Eastern, US/East-Indiana
JSON Array of Strings
linked-locks Locks linked with the listing.JSON Array of Strings

Request
$ curl -X GET -H " x-temporary-token: Pb61gMHBOP2QiTyDgdBoB5riwzaMJbyjd09Av2CG2t4ztvt8Q09kDu6At91npgS7ifTHpV2nnhWPt8L3omF1g==" https://api.aurmur.com/v1/listings

Response
'[
{
"listing-id" : "CR1KtOV5nBpY91",
"listing-name" : "quiet house",
"code-length" : 4,
"timezone" : "US/Pacific",
"linked-locks" : [ "ba01e46e8-e1be-4803-8d22-d3398f325d44" ] }
]'



Http Status Codes

Http Status Codes Status are provided in all server responses.


Http Status CodeMeaning
200Success
400Bad Request Exception
401Not Authorized
403Access Denied Exception
404Not Found Exception
409Conflict Exception
411Too Many Tokens
412Token Expired
413Missing Parameter
414Invalid Request
429Too Many Requests Exception
502Bad Gateway Exception
503Service Unavailable Exception
504Endpoint Request Timed-out Exception
505Error processing reqest