Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

* [Introduction](README.md)
* [Use cases](use-cases/README.md)
* [Access & Identity Management](use-cases/access-and-identity.md)
* [Accounting](use-cases/accounting.md)
* [Customer management](use-cases/customer-management.md)
* [Device integrations](use-cases/device-integrations.md)
Expand Down
4 changes: 4 additions & 0 deletions changelog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ For more details, see [Environments](../guidelines/environments.md).

# Changelog

## 15th September 2022

* Added new use case for [Access & Identity Management](../use-cases/access-and-identity.md)

## 13th September 2022

* Added [Pagination](../guidelines/pagination.md) to [Get All Customers](../operations/customers.md#get-all-customers).
Expand Down
1 change: 1 addition & 0 deletions use-cases/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ This section describes how to use the __Mews Connector API__ in order to impleme
Even if you are integrating a different type of system, it serves as a good starting point for API usage patterns and practices.
The following types of system are described here:

* [Access & Identity Management](access-and-identity.md)
* [Accounting](accounting.md)
* [Customer management](customer-management.md)
* [Device integrations](device-integrations.md)
Expand Down
23 changes: 23 additions & 0 deletions use-cases/access-and-identity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Access & Identity Management

Access & Identity systems integrating with Mews can store and retrieve **PIN codes** and **RFID tags** against a guest reservation.
These could, for example, be associated with a key card carried by the guest, or with a coded wristband or bracelet worn by the guest.
Systems that detect such cards or bracelets can then look up the guest details via the API to determine access permissions or for posting of charges to the guest account.

### Resource access token

The relevant API operations are based around the [`resource access token`](../operations/resourceaccesstokens.md#resource-access-token). It is this token that represents the PIN code or RFID tag and is stored against the reservation.
The resource access token grants access to specified resources or services for a specified period of time and with specified permissions.
The token has a `Value` attribute and a separate `SerialNumber` attribute, the latter could be used to store some associated entity like a key card or wristband which has meaning within the Access & Identity system.
`Permissions` are used to specify the scope of access, e.g. Room, Floor.

> **Terminology:** Note that a _resource access token_ is completely separate from and unrelated to the _access token_ used by client applications to access the Mews Connector API; and the word _resource_ is used here in the broadest sense and does not necessarily imply a _space_.

### API operations

| Operation or Endpoint | Description |
| :-- | :-- |
| [Get all resource access tokens](../operations/resourceaccesstokens.md#get-all-resource-access-tokens) | Returns all resource access tokens (may be filtered by resource access token, reservation or time interval) |
| [Add resource access tokens](../operations/resourceaccesstokens.md#add-resource-access-tokens) | Adds new resource access tokens with the specified data |
| [Update resource access tokens](../operations/resourceaccesstokens.md#update-resource-access-tokens) | Updates resource access token validity time intervals and permissions |
| [Delete resource access tokens](../operations/resourceaccesstokens.md#delete-resource-access-tokens) | Delete specified resource access tokens |