Contents
Permanent tokens are created and managed through Aurmur's website.
Go to the Account > API Menu.
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
| Field | Description | Type |
|---|---|---|
| temporary-token | Temporary token used for calling other API | String |
| epoch-time | Epoch 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 the locks which are registered in linked SmartThings accounts.
URL: GET https://api.aurmur.com/v1/listlocks/
Header: x-temporary-token
Response
| Field | Description | Type |
|---|---|---|
| JSON Array | ||
| lock-id | ID for lock. Same ID as lock deviceid in SmartThings | String |
| lock-name | Lock name in Aurmur | String |
| smartthings-name | Name from SmartThings | String |
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"
}'
]'
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
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
Show the status of locks.
URL: GET https://api.aurmur.com/v1/lockstatus/?lock-id=<lock-id>
Header: x-temporary-token
Request
| Field | Description | Type |
|---|---|---|
| lock-id | lock-id for which to get status information. lock-id=all can be provided to return all lock status information | String |
Response
| Field | Description | Type |
|---|---|---|
| JSON Array | ||
| lock-id | ID for lock. Same ID as lock deviceid in SmartThings. | String |
| lock-name | Lock name in Aurmur. | String |
| state | Lock state Values: locked, unlocked, unknown | String |
| battery | Battery Percentage | Number (Optional) |
| last-update | Minutes 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
}'
]'
Show locks lock and unlock activity.
URL: GET https://api.aurmur.com/v1/lockevents?lock-id=<lock-id>
Header: x-temporary-token
Request
| Field | Description | Type |
|---|---|---|
| lock-id | lock-id for which to get lock events. lock-id=all can be provided to return events for all locks. | String |
Response
| Field | Description | Type |
|---|---|---|
| JSON Array | ||
| lock-event-id | Lock event ID | String |
| lock-id | ID for lock. Same ID as lock deviceid in SmartThings. | String |
| lock-name | Lock name in Aurmur. | String |
| action | Whether locks was locked, unlocked, jammed, or tampered. Values: locked, unlocked, jammed, or tampered | String |
| method | How action was performed. Values: manual, keypad, portal, api | String (Optional) |
| kind | Kind of code used. Only relevant for unlock actions. Values: guest, programmed, or unknown | String (Optional) |
| listing-id | Listing ID Only relevant for guest and programmed unlock actions. | String (Optional) |
| listing-name | Listing name Only relevant for guest and programmed unlock actions. | String (Optiona) |
| used-code | Memory location in lock's memory Only relevant for unlock actions. | String (Optional) |
| code-id | Code ID Only relevant for guest and programmed unlock actions.Only relevant for guest and programmed unlock actions. | String (Optional) |
| code-name | Name of code Only relevant for unlock actions with programmed codes. | String (Optional) |
| guest-information | Guest information Only relevant for guest unlocking with automated guest code. | String (Optional) |
| event-epoch | Epoch 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 programmed codes.
URL: GET https://api.aurmur.com/v1/codes
Header: x-temporary-token
Response
| Field | Description | Type |
|---|---|---|
| JSON Array | ||
| code-id | Code ID | String |
| code-name | Code name | String |
| listing-id | Listing ID | String |
| listing-name | Name of listing | String |
| deleted | Set to true when code is in process of being deleted | Boolean |
| status | Status of code Values: activation_pending, activation_pending_with_failure, activated, deactivated, deactivation_pending, deactivation_pending_with_failure, new | String |
| lock-status | Status of code per lock | JSON Array of Lock Information Objects |
| manual | Manually manage activation and deactivation. Values: activated or deactivated. If this is set, then the daterange, hoursperday, and daysofeachweek cannot be set. | String (Optional) |
| unlock-notifications | Notifications to be sent when unlocked Values: first-use, every-use | String (Optional) |
| daterangestart | Start of date range for code to be activate. Format: MM/dd/yyyy hh:mm a | String (Optional) |
| daterangeend | End 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
| Field | Description | Type |
|---|---|---|
| lock-id | Lock ID | String |
| status | Status 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 a code.
URL: POST https://api.aurmur.com/v1/codes/
Header: x-temporary-token
Request
| Field | Description | Type |
|---|---|---|
| code-name | Code name | String |
| listing-id | ID for listing. | String |
| code | 4 to 8 digit code to unlock door. | Number |
| unlock-notifications | Notifications to be sent when unlocked Values: first-use, every-use. | String (Optional) |
| manual | Manually manage activation and deactivation. Values: activated or deactivated. If this is set, then the daterange, hoursperday, and daysofeachweek cannot be set. | String (Optional) |
| daterangestart | Start of date range for code to be activate. Format: MM/dd/yyyy hh:mm a | String (Optional) |
| daterangeend | End 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
| Field | Description | Type |
|---|---|---|
| code-id | Code ID | String |
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",
}'
Request
$ curl -X DELETE -H " x-temporary-token: Pb61gMHBOP2QiTyDgdBoB5riwzaMJbyjd09Av2CG2t4ztvt8Q09kDu6At91npgS7ifTHpV2nnhWPt8L3omF1g==" https://api.aurmur.com/v1/codes/095218ab-6206-47c5-857d-52cf9412a594
Update existing code.
URL: PUT https://api.aurmur.com/v1/codes/<code-id>
Header: x-temporary-token
Request
| Field | Description | Type |
|---|---|---|
| code-name | Code name Previous value is kept if not provided. | String (optional) |
| unlock-notifications | Notifications to be sent when unlocked Values: first-use, every-use | String (optional) |
| manual | Manually manage activation and deactivation. Values: activated or deactivated. If this is set, then the daterange, hoursperday, and daysofeachweek cannot be set. | String (optional) |
| daterangestart | Start of date range for code to be activate. Format: MM/dd/yyyy hh:mm a | String (optional) |
| daterangeend | End 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.
URL: GET https://api.aurmur.com/v1/listings
Header: x-temporary-token
Response
| Field | Description | Type |
|---|---|---|
| JSON Array | ||
| listing-id | Listing ID | String |
| code-length | Length 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 Status are provided in all server responses.
| Http Status Code | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request Exception |
| 401 | Not Authorized |
| 403 | Access Denied Exception |
| 404 | Not Found Exception |
| 409 | Conflict Exception |
| 411 | Too Many Tokens |
| 412 | Token Expired |
| 413 | Missing Parameter |
| 414 | Invalid Request |
| 429 | Too Many Requests Exception |
| 502 | Bad Gateway Exception |
| 503 | Service Unavailable Exception |
| 504 | Endpoint Request Timed-out Exception |
| 505 | Error processing reqest |
Copyright 2020 Aurmur
