Skip to content

Device management

Note

We're sorry, this article hasn't been completed or updated yet. We're working on finishing it as soon as possible. In case of any questions, please reach out to our Support Team.

One of the main reason for existence of Kontakt.io API, Panel, and backend in general is to provide our customers with a way to easily keep track of their Kontakt.io devices. In order to take full advantage of Kontakt.io platform, one of the first steps for new users should be understanding how devices are assigned to an account, how to move them to different (sub-)accounts, and how to share access to them with others.

Adding devices to an account

Whenever a new beacons are purchased in Kontakt.io Web Store or through our Sales Team, they are bundled under a single Order ID - all devices purchased at the same time share it.

Order ID is used to assign newly produced beacons to a Kontakt.io Panel account. This is usually done in Panel itself, and instructions how to do it are available on our Support Center.

Warning

Order ID is a one-time-use code. Once someone enters it in the Kontakt.io Panel or use it via API, it can't be used again to assign beacons from that order to a different account.

There is, however, an API endpoint just for that - POST /order/assign:

POST /order/assign HTTP/1.1
Accept: application/vnd.com.kontakt+json;version=10
Api-Key: yourSuperSecretAPIKey
Content-Type: application/x-www-form-urlencoded; charset=utf-8
Host: api.kontakt.io
Connection: close
User-Agent: Paw/3.1.4 (Macintosh; OS X/10.13.2) GCDHTTPRequest
Content-Length: 23

orderId=aaabbb%2C123dfg

It will automatically add all devices from specified orders to the account from where the API key has come from.

Moving

After assigning beacons from a new order to an account, manager of that account becomes an OWNER of these beacons. OWNER has full access to beacons, can change all parameters on them, asl well as move them to different accounts. However, when it come to moving, there are some differences in the process, depending on the relation between the OWNER account and an account that should receive some devices.

Note

Before proceeding, please make sure you understand how does the account structure looks like on Kontakt.io backend.

Within a Company

If a manager is an OWNER or has a SUPERVISOR type of access to a device,

Outside a Company

POST /device/move HTTP/1.1
Accept: application/vnd.com.kontakt+json;version=10
Api-Key: yourSuperSecretAPIKey
Content-Type: application/x-www-form-urlencoded; charset=utf-8
Host: api.kontakt.io
Connection: close
User-Agent: Paw/3.1.4 (Macintosh; OS X/10.13.3) GCDHTTPRequest
Content-Length: 48

uniqueId=U4OP&managerEmail=username%40domain.tld

Sharing

POST /device/share HTTP/1.1
Accept: application/vnd.com.kontakt+json;version=10
Api-Key: yourSuperSecretAPIKey
Content-Type: application/x-www-form-urlencoded; charset=utf-8
Host: api.kontakt.io
Connection: close
User-Agent: Paw/3.1.4 (Macintosh; OS X/10.13.3) GCDHTTPRequest
Content-Length: 110

uniqueId=1nau&managerMail=marty.mchack%40kontakt.io&access=EDITOR&expirationDate=1516876204&withMetadata=true